<table><tr><td>[[image:Cube-icon.png | link=Getting_Started_with_EM.Cube]] [[image:cad-ico.png | link=Building_Geometrical_Constructions_in_CubeCAD]] [[image:fdtd-ico.png | link=EM.Tempo]] [[image:prop-ico.png | link=EM.Terrano]] [[image:static-ico.png | link=EM.Ferma]] [[image:planar-ico.png | link=EM.Picasso]] [[image:metal-ico.png | link=EM.Libera]] [[image:po-ico.png | link=EM.Illumina]]</td><tr></table>[[Image:Back_icon.png|30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''<br />Â == Standard Python Operators ==Â {| class="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description|-| style="width:80px;" | -p| style="width:150px;" | Std. Python operator| style="width:270px;" | negative of p|-| style="width:80px;" | p=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is equal to q|-| style="width:80px;" | p+q| style="width:150px;" | Std. Python operator| style="width:270px;" | sum of p and q|-| style="width:80px;" | p-q| style="width:150px;" | Std. Python operator| style="width:270px;" | difference p and q|-| style="width:80px;" | p*q| style="width:150px;" | Std. Python operator| style="width:270px;" | product of p and q|-| style="width:80px;" | p/q| style="width:150px;" | Std. Python operator| style="width:270px;" | quotient of p over q|-| style="width:80px;" | p**q| style="width:150px;" | Std. Python operator| style="width:270px;" | p to the power of q|-| style="width:80px;" | p%q| style="width:150px;" | Std. Python operator| style="width:270px;" | p modulus q|-| style="width:80px;" | p==q| style="width:150px;" | Std. Python operator| style="width:270px;" | p logically equal to q|-| style="width:80px;" | p>q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is greater than q|-| style="width:80px;" | p>=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is greater than or equal to q|-| style="width:80px;" | p<q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is less than q|-| style="width:80px;" | p<=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is less than or equal to q|-| style="width:80px;" | !p| style="width:150px;" | Std. Python operator| style="width:270px;" | Logical not p|-| style="width:80px;" | p and q| style="width:150px;" | Std. Python operator| style="width:270px;" | p Boolean and q|-| style="width:80px;" | p or q| style="width:150px;" | Std. Python operator| style="width:270px;" | p Boolean or q|-|}Â == Basic Mathematical Python Functions ==
{| class="wikitable"
| style="width:270px;" | Absolute value function
| style="width:270px;" | x if x>0, -x if x<0
|-
| ceiling(x)
| Std. Python function
| Ceiling function
| Nearest integer >= x
|-
| floor(x)
| Std. Python function
| Floor function
| Nearest integer <= x
|-
| pow(x,y)
| Std. Python function
| Factorial
| For for integer values of x: n! = n(n-1)(n-2)...3.2.1
|-
| max(x,y)
| -
|-
| asinhnp.arcsinh(x)
| Std. Python function
| Inverse hyperbolic sine function
| -
|-
| acoshnp.arccosh(x)
| Std. Python function
| Inverse hyperbolic cosine function
| -
|-
| atanhnp.arctanh(x)
| Std. Python function
| Inverse hyperbolic tangent function
| -
|-
| np.floor(x)
| Std. Python function
| Floor function
| nearest integer <= x
|}
| style="width:150px;" | Std. Python function
| style="width:270px;" | Sine and cosine integral functions
| style="width:270px;" | See see [https://en.wikipedia.org/wiki/Trigonometric_integral Trigonometric Integrals on Wikipedia.]
|-
| sp.fresnel(x)
| Std. Python function
| Sine and cosine Fresnel integral functions
| See see [https://en.wikipedia.org/wiki/Fresnel_integral Fresnel Integrals on Wikipedia.]
|-
| sp.ellipe(x)
| Std. Python function
| Elliptic function of the first kind
| See see [https://en.wikipedia.org/wiki/Elliptic_integral Elliptic Integrals on Wikipedia.]
|-
| sp.ellipk(x)
| Std. Python function
| Elliptic function of the second kind
| See see [https://en.wikipedia.org/wiki/Elliptic_integral Elliptic Integrals on Wikipedia.]
|-
| sp.expi(x)
| Std. Python function
| Exponential integral function
| See see [https://en.wikipedia.org/wiki/Exponential_integral Exponential Integrals on Wikipedia.]
|-
| sp.expn(n,x)
| Std. Python function
| Generalized exponential integral function of order n
| See see [https://en.wikipedia.org/wiki/Exponential_integral Exponential Integrals on Wikipedia.]
|-
| sp.erf(x)
| Std. Python function
| Error function
| See see [https://en.wikipedia.org/wiki/Error_function Error Function on Wikipedia.]
|-
| sp.erfc(x)
| Std. Python function
| Complementary error function
| See see [https://en.wikipedia.org/wiki/Error_function Error Function on Wikipedia.]
|-
| sp.gamma(x)
| Std. Python function
| Gamma function
| See see [https://en.wikipedia.org/wiki/Gamma_function Gamma Function on Wikipedia.]
|-
| sp.airy(x)
| Std. Python function
| Airy function of the first (Ai) and second (Bi) kind and their derivatives
| See see [https://en.wikipedia.org/wiki/Airy_function Airy Functions on Wikipedia.]
|-
| sp.j0(x)
| Std. Python function
| Bessel function of the first kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.j1(x)
| Std. Python function
| Bessel function of the first kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.jv(n,x)
| Std. Python function
| Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.y0(x)
| Std. Python function
| Bessel function of the second kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.y1(x)
| Std. Python function
| Bessel function of the second kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.yv(n,x)
| Std. Python function
| Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.i0(x)
| Std. Python function
| Modified Bessel function of the first kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.i1(x)
| Std. Python function
| Modified Bessel function of the first kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.iv(n,x)
| Std. Python function
| Modified Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.k0(x)
| Std. Python function
| Modified Bessel function of the second kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.k1(x)
| Std. Python function
| Modified Bessel function of the second kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.kv(n,x)
| Std. Python function
| Modified Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_jn(n,x)
| Std. Python function
| Spherical Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_yn(n,x)
| Std. Python function
| Spherical Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_in(n,x)
| Std. Python function
| Modified spherical Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_kn(n,x)
| Std. Python function
| Modified spherical Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.lpn(n,x)
| Std. Python function
| Legendre function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomial Legendre Polynomials on Wikipedia.]
|-
| sp.lqn(n,x)
| Std. Python function
| Legendre function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.lpmn(m,n,x)
| Std. Python function
| Associated Legendre function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomial Legendre Polynomials on Wikipedia.]
|-
| sp.lqmn(m,n,x)
| Std. Python function
| Associated Legendre function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.eval_chebyt(n,x)
| Std. Python function
| Chebyshev polynomial of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Chebyshev_polynomials Chebyshev Polynomials on Wikipedia.]
|-
| sp.eval_chebyu(n,x)
| Std. Python function
| Chebyshev polynomial of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Chebyshev_polynomials Chebyshev Polynomials on Wikipedia.]
|-
| sp.eval_legendre(n,x)
| Std. Python function
| Legendre polynomial of order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.eval_laguerre(n,x)
| Std. Python function
| Laguerre polynomial of order n
| See see [https://en.wikipedia.org/wiki/Laguerre_polynomials Laguerre Polynomials on Wikipedia.]
|-
| sp.eval_hermite(n,x)
| Std. Python function
| Hermite polynomial of order n
| See see [https://en.wikipedia.org/wiki/Hermite_polynomials Hermite Polynomials on Wikipedia.]
|-
| Math_cesp.mathieu_cem(n,rq,x)
| Std. Python function
| Even periodic (cosine) Mathieu function of order nand its derivative| See see [https://en.wikipedia.org/wiki/Mathieu_function Mathieu Functions on Wikipedia.]
|-
| Math_sesp.mathieu_sem(n,rq,x)
| Std. Python function
| Odd periodic (sine) Mathieu function of order nand its derivative| See see [https://en.wikipedia.org/wiki/Mathieu_function Mathieu Functions on Wikipedia.]
|}
== EM.Cube's Miscellaneous Native Python Functions ==
{| class="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description!scopeactivate="col"| Notes|-| style="width:80px;" | rect(x)| style="width:150px;" | EMAG Python function| style="width:270px;" | Rectangle function| style="width:270px;" | 1 if |x|≤0.5, 0 elsewhere |-| tri(x)| EMAG Python function| Triangle function| 1 if |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: activate({{ArgTypeString}} group_node_label)
{| class=EXAMPLE: ''activate("wikitableColor_1")'' DESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube]] module for insertion of new objects.  !scope====add_variable==== SYNTAX: add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value) EXAMPLE: ''add_variable("colMyVar"| Syntax,1)'' DESCRIPTION: Adds a new variable to [[EM.Cube]]'s variable list. !scope====array==== SYNTAX: array({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing) EXAMPLE: ''array("colArray_1"| Type,"Rect_Strip_1",4,4,1,50,50,0)'' DESCRIPTION: Creates or modifies an array object. !scope====array_custom==== SYNTAX: array_custom({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z) EXAMPLE: ''array_custom("colArray_1"| Description,"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. !scope====background_layer==== SYNTAX: background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness) EXAMPLE: ''background_layer("colMid_Layer"| Notes,3.3,0.001,1,1.5)'' DESCRIPTION: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.|-| style="width===base_point_group==== SYNTAX:100px;base_point_group({{ArgTypeString}} label) EXAMPLE: ''base_point_set(" | microstrip_designBP_Set_1")'' DESCRIPTION: Creates a base point set in [[EM.Terrano]]. If the base point set group 'label' already exists, the group is activated. ====bh_step==== SYNTAX: bh_step(z0{{ArgTypeReal}} x,er{{ArgTypeReal}} T)| styleEXAMPLE: ''bh_step(0.5,1)'' DESCRIPTION: Computes and returns the Blackman-Harris step function. ="width===bh_window==== SYNTAX:150px;" | EMAG Python bh_window({{ArgTypeReal}} x, {{ArgTypeReal}} T) EXAMPLE: ''bh_window(0.5,1)'' DESCRIPTION: Computes and returns the Blackman-Harris window function. | style="width===box==== SYNTAX:250px;box({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height[, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]) EXAMPLE: ''box(" | Returns Box_1",0,0,0,50,50,100)'' DESCRIPTION: Draws a box object in the widthproject workspace under the currently activated material group node, or modifies the box named 'label' if it already exists. ====capacitance==== SYNTAX: capacitance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4) EXAMPLE: ''capacitance("FI_1",-to10,-height ratio of 10,5,10,10,10,0,0,-10,0,0,10)'' DESCRIPTION: Creates a microstrip transmission line capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. | style="width===capacitor==== SYNTAX:250px;capacitor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pF) EXAMPLE: ''capacitor(" | z0Cap_1","Line_1",25,10)'' DESCRIPTION: characteristic impedance Creates a capacitor in Ohms[[EM.Tempo]]. If the capacitor 'label' already exists, erits properties are modified. ====charge_group==== SYNTAX: substrate permittivitycharge_group({{ArgTypeString}} label, {{ArgTypeAny}} 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. | style="width===circ_strip==== SYNTAX:100px;" | microstrip_z0circ_strip(w{{ArgTypeString}} label,h{{ArgTypeAny}} x0,er{{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} inner_radius, {{ArgTypeAny}} outer_radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])| style=EXAMPLE: ''circ_strip("widthcs_1",0,0,0,50,0)'' DESCRIPTION:150px;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. ====circle==== SYNTAX: circle({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle) EXAMPLE: ''circle(" | EMAG Python functionpyramid_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. | style====clone==== SYNTAX: clone({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeReal}} x0, {{ArgTypeReal}} y0, {{ArgTypeReal}} z0) EXAMPLE: ''clone("widthNewObj","MyObj",10,10,0)'' DESCRIPTION:250px;Creates a copy of the specified object and repositions it at the given coordinates.  ====close_curve==== SYNTAX: close_curve({{ArgTypeString}} label, {{ArgTypeString}} close_state) EXAMPLE: ''close_curve(" | Returns Curve_1",1)'' DESCRIPTION: Sets the characteristic impedance open/close state of a microstrip polyline or NURBS curve. Use 0 for open curve and 1 for close curve. ====coaxial_design==== SYNTAX: coaxial_design({{ArgTypeReal}} z0, {{ArgTypeReal}} er) EXAMPLE: ''coaxial_design(50,2.2)'' DESCRIPTION: Computes and returns the ratio of the radius of the outer conductor to the radius of the inner conductor of a coaxial transmission line of characteristic impedance z0 (in Ohms ) with core relative permittivity er. | style="width===coaxial_src==== SYNTAX:250px;coaxial_src({{ArgTypeString}} label, {{ArgTypeAny}} cylinder_object, {{ArgTypeAny}} outer_radius, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''coaxial_src(" | wCOAX_1","Cyl_1",1.5,"+z")'' DESCRIPTION: microstrip widthCreates a coaxial port source in [[EM.Tempo]]. If the coaxial port 'label' already exists, hits properties are modified. ====color_group==== SYNTAX: substrate heightcolor_group({{ArgTypeString}} label) EXAMPLE: ''color_group("Color_1")'' DESCRIPTION: Creates a color group in CubeCAD module. If the color group 'label' already exists, erthe group is activated. ====conduction_current_integral==== SYNTAX: substrate permittivityconduction_current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} 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. | style="width===conductive_sheet_group==== SYNTAX:100px;" | microstrip_eps_effconductive_sheet_group(w{{ArgTypeString}} label,h{{ArgTypeAny}} sigma,er{{ArgTypeAny}} thickness)| style="widthEXAMPLE:150px;''conductive_sheet_group(" | EMAG Python functionCond_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. | style="width===cone==== SYNTAX:250px;cone({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} top_radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]) EXAMPLE: ''cone(" | Returns Cone_1",0,0,0,30,40,20,0,180)'' DESCRIPTION: Draws a cone object in the effective permittivity of 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 microstrip transmission line sweep about the cone's azimuth axis. | style="width===consolidate==== SYNTAX:250px;consolidate({{ArgTypeString}} object) EXAMPLE: ''consolidate(" | wPoly_1")'' DESCRIPTION: microstrip widthConsolidates a specified object. ====cpw_design_s==== SYNTAX: cpw_design_s({{ArgTypeReal}} z0, {{ArgTypeReal}} w, {{ArgTypeReal}} h: substrate height, {{ArgTypeReal}} er) EXAMPLE: ''cpw_design_s(50,2,0.5,2.2)'' DESCRIPTION: Computes and returns the center strip width (in meters) of a CPW transmission line of characteristic impedance z0 with slot width w, substrate height h and substrate relative permittivityer.|-| style="width===cpw_design_w==== SYNTAX:100px;" | microstrip_lambda_gcpw_design_w(w{{ArgTypeReal}} z0,{{ArgTypeReal}} s, {{ArgTypeReal}} h,{{ArgTypeReal}} er,freq_hertz)| style="widthEXAMPLE:150px;" | EMAG Python function''cpw_design_w(50,1,0.5,2.2)''| style="widthDESCRIPTION:250px;" | Returns Computes and returns the guide wavelength slot width (in meters) of a microstrip CPW transmission line of characteristic impedance z0 with center strip width s, substrate height h and substrate relative permittivity er. ====cpw_src==== SYNTAX: cpw_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''cpw_src("CPW_1","Rect_1",1.5,"+x")'' DESCRIPTION: Creates a CPW port source in meters[[EM.Tempo]]. If the CPW port 'label' already exists, its properties are modified. | style====cubecad_mesh_settings==== SYNTAX: cubecad_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol) EXAMPLE: ''cubecad_mesh_settings(5,10)'' DESCRIPTION: Sets the parameters of CubeCAD's mesh generator. ====current_dist==== SYNTAX: current_dist({{ArgTypeString}} label) EXAMPLE: ''current_dist("widthCD_1")'' DESCRIPTION:250px;Creates a current distribution observable. If the observable 'label' already exists, its properties are modified. ====current_integral==== SYNTAX: current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''current_integral(" | wFI_1",-10,-10,0,10,10,0)'' DESCRIPTION: microstrip widthCreates a current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, hits properties are modified. ====cylinder==== SYNTAX: substrate cylinder({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} height[, er{{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]) EXAMPLE: substrate permittivity''cylinder("Cylinder_1", freq_hertz0,0,0,10,100)'' DESCRIPTION: frequency Draws a cylinder object in Hzthe 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.|-| style====delete==== SYNTAX: delete({{ArgTypeString}} node_name) EXAMPLE: ''delete("widthBox_1")'' DESCRIPTION:100px;Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.  ====delete_background_layer==== SYNTAX: delete_background_layer({{ArgTypeString}} label) EXAMPLE: ''delete_background_layer(" | cpw_design_wMid_Layer")'' DESCRIPTION: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup. ====dielectric_group==== SYNTAX: dielectric_group(z0{{ArgTypeString}} label,s{{ArgTypeAny}} eps,h{{ArgTypeAny}} sigma,er{{ArgTypeAny}} mu, {{ArgTypeAny}} rho)| style=EXAMPLE: ''dielectric_group("widthDielectric_1","my_eps",0,1,0)'' DESCRIPTION:150px;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. ====diode==== SYNTAX: diode({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} polarity, {{ArgTypeAny}} is_fA, {{ArgTypeAny}} temperature_K, {{ArgTypeAny}} ideality_factor) EXAMPLE: ''diode(" | EMAG Python functionDiode_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. | style====distributed_src==== SYNTAX: distributed_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''distributed_src("widthDS_1","Rect_1","+y","uniform")'' DESCRIPTION:250px;Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already exists, its properties are modified. ====ellipse_strip==== SYNTAX: ellipse_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) EXAMPLE: ''ellipse_strip(" | Returns es_1",0,0,0,50,0)'' DESCRIPTION: Draws a ellipse strip object in the slot width of 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 coplanar waveguide sweep about the ellipse strip's azimuth axis. ====ellipsoid==== SYNTAX: ellipsoid(CPW{{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y, {{ArgTypeAny}} radius_z[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) transmission line | style="widthEXAMPLE:250px;''ellipsoid(" | z0Ellipsoid_1",0,0,0,100,100,50,0,360)'' DESCRIPTION: characteristic impedance Draws an ellipsoid object in Ohmsthe 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'sazimuth axis. ====emferma_engine_settings==== SYNTAX: center strip width emferma_engine_settings(or slot spacing{{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations) EXAMPLE: ''emferma_engine_settings("bicg-stab", h1e-3,100)'' DESCRIPTION: substrate heightSets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines. ====emferma_mesh_settings==== SYNTAX: emferma_mesh_settings({{ArgTypeAny}} cell_size_x, er{{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} cell_size_z) EXAMPLE: substrate permittivity''emferma_mesh_settings(0.5,0.5,0.5)''|DESCRIPTION: Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator. | style="width===emillumina_engine_settings==== SYNTAX:100px;" | cpw_design_semillumina_engine_settings(z0{{ArgTypeString}} engine,w{{ArgTypeAny}} is_fixed_iteration,h{{ArgTypeAny}} error_tol,er{{ArgTypeAny}} max_iterations)| styleEXAMPLE: ''emillumina_engine_settings("ipo",0,1e-2,20)'' DESCRIPTION: Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine. ====emillumina_mesh_settings==== SYNTAX: emillumina_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''emillumina_mesh_settings(30)'' DESCRIPTION: Sets the parameters of [[EM.Illumina]]'s mesh generator. ====emlibera_engine_settings_smom==== SYNTAX: emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} alpha) EXAMPLE: ''emlibera_engine_settings_smom("widthbicg",1e-3,1000,4,"efie",0.4)'' DESCRIPTION:150px;Sets the parameters of [[EM.Libera]]'s surface MoM simulation engines. ====emlibera_engine_settings_wmom==== SYNTAX: emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations) EXAMPLE: ''emlibera_engine_settings_wmom(" | EMAG Python functionbicg",1e-3,1000)'' DESCRIPTION: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines. | style====emlibera_mesh_settings==== SYNTAX: emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''emlibera_mesh_settings(30)'' DESCRIPTION: Sets the parameters of [[EM.Libera]]'s mesh generator. ====empicasso_engine_settings==== SYNTAX: empicasso_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations) EXAMPLE: ''empicasso_engine_settings("widthbicg",1e-3,1000)'' DESCRIPTION:250px;Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine. ====empicasso_mesh_settings==== SYNTAX: empicasso_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''empicasso_mesh_settings(30)'' DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator. ====emtempo_engine_settings==== SYNTAX: emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps) EXAMPLE: ''emtempo_engine_settings(" | Returns single-precision",-50,20000)'' DESCRIPTION: Sets the center strip width parameters of [[EM.Tempo]]'s FDTD simulation engine. ====emtempo_mesh_settings==== SYNTAX: emtempo_mesh_settings(or slot spacing{{ArgTypeAny}} cells_per_lambda, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs)  EXAMPLE: ''emtempo_mesh_settings(30,0.1,0.1,0.02)'' DESCRIPTION: Sets the parameters of a coplanar waveguide [[EM.Tempo]]'s adaptive mesh generator. ====emterrano_engine_settings==== SYNTAX: emterrano_engine_settings(CPW{{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold) transmission line | styleEXAMPLE: ''emterrano_engine_settings(5,1,1,-100)'' DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine. ="width===emterrano_mesh_settings==== SYNTAX:250px;emterrano_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol) EXAMPLE: ''emterrano_mesh_settings(5,10)'' DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s facet mesh generator. ====energy_electric==== SYNTAX: energy_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''energy_electric(" | z0FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: characteristic impedance Creates an electric energy integral observable in Ohms[[EM.Ferma]]. If the observable 'label' already exists, wits properties are modified. ====energy_magnetic==== SYNTAX: slot widthenergy_magnetic({{ArgTypeString}} label, h{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: substrate height''energy_magnetic("FI_1", er-10,-10,-10,10,10,10)'' DESCRIPTION: substrate permittivityCreates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.|-| style="width===explode==== SYNTAX:100px;explode({{ArgTypeString}} object) EXAMPLE: ''explode(" | coaxial_designMyArray")'' DESCRIPTION: Explodes an object into its basic primitives. ====export_dxf==== SYNTAX: export_dxf(z0,er{{ArgTypeString}} file_name)| styleEXAMPLE: ''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({{ArgTypeString}} file_name) EXAMPLE: ''export_py("widthMyPYModel.PY")'' DESCRIPTION:150px;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 Python function". | style="width===export_stl==== SYNTAX:250px;export_stl({{ArgTypeString}} file_name) EXAMPLE: ''export_stl(" | Returns MySTLModel.STL")'' DESCRIPTION: Exports the ratio of radius physical structure of the outer conductor project workspacean to an STL model file. If the radius of file path is not specified, the inner condutcor of a coaxial transmission line current project folder is assumed as the path. | style====extrude==== SYNTAX: extrude({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} extrude_height, {{ArgTypeAny}} cap_ends) EXAMPLE: ''extrude("widthExtrude_1","Rect_Strip1",50)'' DESCRIPTION:250px; 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. ====farfield==== SYNTAX: farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} 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. ====field_probe==== SYNTAX: field_probe({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0) EXAMPLE: characteristic impedance ''field_probe("FS_1",0,0,50)'' DESCRIPTION: Creates a temporal field probe observable in Ohms[[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, erits properties are modified. ====field_sensor==== SYNTAX: core permittivityfield_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} 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. | style====field_sensor_grid==== SYNTAX: field_sensor_grid({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0) EXAMPLE: ''field_sensor_grid("widthFS_1","z",0,0,0)'' DESCRIPTION:100px;Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====fill_curve==== SYNTAX: fill_curve({{ArgTypeString}} object) EXAMPLE: ''fill_curve(" | waveguide_designCurve_1")'' DESCRIPTION: Fill the interior of the specified closed curve object. ====fillet==== fillet(er{{ArgTypeString}} object,freq_hertz{{ArgTypeAny}} radius)| styleEXAMPLE: ''fillet("Rect_1",5)'' DESCRIPTION: Fillets the corners of the specified surface or curve object by the specified radius. ====flux_electric==== SYNTAX: flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''flux_electric("widthFI_1",-10,-10,5,10,10,10)'' DESCRIPTION:150px;Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====flux_magnetic==== SYNTAX: flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''flux_magnetic(" | EMAG Python functionFI_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. | style====fractal_tree==== SYNTAX: fractal_tree({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} key_type, {{ArgTypeAny}} key_size, {{ArgTypeAny}} n_level, {{ArgTypeAny}} sep_angle, {{ArgTypeAny}} n_gen, {{ArgTypeAny}} prune_factor, {{ArgTypeAny}} thickness, {{ArgTypeAny}} thick_factor) EXAMPLE: ''fractal_tree("widthFractal_1",0,0,0,"line",10,3,30,3,0,0,0)'' DESCRIPTION:250px;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. ====freeze==== SYNTAX: freeze({{ArgTypeString}} object, {{ArgTypeReal}} freeze_state) EXAMPLE: ''freeze(" | Returns MyObj",1)'' DESCRIPTION: Sets the minimum larger dimension in meter freeze state of an object (0/1).  ====gauss==== SYNTAX: gauss({{ArgTypeReal}} x, ArgTypeReal}} mu, ArgTypeReal}} sigma) EXAMPLE: ''gauss(0.5,0,1)'' DESCRIPTION: Computes and returns the cross section Gaussian function of a hollow rectangular waveguide above cutoff mean mu and standard deviation sigma: exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi). | style="width===gauss_beam==== SYNTAX:250px;" | ergauss_beam({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode) EXAMPLE: filling permittivity''gauss_beam("PW_1", freq_hertz180,0,"tm",0,0,0,20,0,0)'' DESCRIPTION: frequency Creates a Gaussian beam source in Hz[[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified.|-| style="width===generate_input_files==== SYNTAX:100px;" | horn_design_agenerate_input_files(D0_dB) EXAMPLE: ''generate_input_files()'' DESCRIPTION: Generates all the input files for the simulation engine of the current module without running a simulation. ====geo==== SYNTAX: geo({{ArgTypeReal}} x,a_lambda{{ArgTypeReal}} y) EXAMPLE: ''geo(1,b_lambda2)'' DESCRIPTION: Computes and returns the geometric mean of x and y: sqrt(x*y). | style="width===get_area==== SYNTAX:150px;get_area({{ArgTypeString}} object) EXAMPLE: ''get_area(" | EMAG Python functionellipse_1")'' DESCRIPTION: Returns the area of a surface object or the total surface area of a solid object. | style="width===get_axis==== SYNTAX:250px;get_axis({{ArgTypeString}} object, {{ArgTypeString}} axis, {{ArgTypeString}} coordinate) EXAMPLE: ''get_axis(" | pyramid_1","x","y")'' DESCRIPTION: Returns the wavelength-normalized larger dimension specified coordinate of the aperture unit vector along the specified local axis of an optimal pyramidal horn antenna object. | style="width===get_domain_extent==== SYNTAX:250px;get_domain_extent({{ArgTypeString}} coordinate) EXAMPLE: ''get_domain_extent(" | D0_dBx")'' DESCRIPTION: directivity dReturns the size of the computational domain along the specified direction. ====get_extent==== SYNTAX: get_extent({{ArgTypeString}} object, a_lambda{{ArgTypeString}} coordinate) EXAMPLE: wavelength-normalized larger dimension ''get_extent("pyramid_1","x")'' DESCRIPTION: Returns the size of the feed waveguidebounding box of an object along the specified direction. ====get_lcs==== SYNTAX: get_lcs({{ArgTypeString}} object, b_lambda{{ArgTypeString}} coordinate) EXAMPLE: wavelength-normalized smaller dimension ''get_lcs("pyramid_1","x")'' DESCRIPTION: Returns the specified coordinate of the feed waveguide LCS of an object.|-| style="width===get_lcs_offset==== SYNTAX:100px;" | horn_design_bget_lcs_offset(D0_dB{{ArgTypeString}} object,a_lambda{{ArgTypeAny}} x_off,b_lambda{{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off, {{ArgTypeString}} coordinate)| style="widthEXAMPLE:150px;''get_lcs_offset(" | EMAG Python functionbox_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. | style="width===get_length==== SYNTAX:250px;get_length({{ArgTypeString}} object) EXAMPLE: ''get_length(" | helix_1")'' DESCRIPTION: Returns the wavelength-normalized smaller dimension length of a curve object. ====get_rot==== SYNTAX: get_rot({{ArgTypeString}} object, {{ArgTypeString}} coordinate) EXAMPLE: ''get_rot("pyramid_1","x")'' DESCRIPTION: Returns the aperture specified rotation angle of an optimal pyramidal horn antenna object. | style="width===get_standard_output==== SYNTAX:250px;get_standard_output({{ArgTypeString}} output_name)  EXAMPLE: ''get_standard_output(" | D0_dBS11M")'' DESCRIPTION: directivity dReturns the computed value of the specified standard output parameter at the end of a simulation. ====get_vertex==== SYNTAX: get_vertex({{ArgTypeString}} object, a_lambda{{ArgTypeAny}} node_index, {{ArgTypeString}} coordinate) EXAMPLE: wavelength-normalized larger dimension ''get_vertex("pyramid_1",0,"x")'' DESCRIPTION: Returns the specified coordinate of the feed waveguidespecified 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, b_lambda: wavelength-normalized smaller dimension while the upper back right corner has an index of 7. The indices are numbered counterclockwise, with the feed waveguide bottom face first and top face next. |-| style="width===get_volume==== SYNTAX:100px;get_volume({{ArgTypeString}} object) EXAMPLE: ''get_volume(" | horn_design_lpyramid_1")'' DESCRIPTION: Returns the volume of a solid object. ====global_ground==== SYNTAX: global_ground(D0_dB{{ArgTypeAny}} ground_on,a_lambda{{ArgTypeAny}} eps,b_lambda{{ArgTypeAny}} sigma)| styleEXAMPLE: ''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 ="width0.  ====group==== SYNTAX:150px;group({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2, ...) EXAMPLE: ''group(" | EMAG Python functionComposite_1","Box_1","Box_2","Box_3")'' DESCRIPTION: Groups a number of objects into a composite object with the given label. | style="width===harm==== SYNTAX:250px;" | Returns harm({{ArgTypeReal}} x, {{ArgTypeReal}} y) EXAMPLE: ''harm(1,2)'' DESCRIPTION: Computes and returns the wavelength-normalized length harmonic mean of an optimal pyramidal horn antenna x and y: 2/(1/x+1/y). | style="width===helix==== SYNTAX:250px;" | D0_dBhelix({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} helix_dir) EXAMPLE: directivity d''helix("Helix_1", a_lambda0,0,0,15,15,10,0)'' DESCRIPTION: wavelength-normalized larger dimension 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 feed waveguidehelix, b_lambda: wavelength-normalized smaller dimension and radius_outer specifies the radius at the end of the feed waveguide helix. If the Boolean parameter "helixl_dir" is 1, the helical curve will be drawn counter-clockwise.|====horn_design_a==== SYNTAX: horn_design_a({{ArgTypeReal}} D0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda) EXAMPLE: ''horn_design_a(15,0.4,0.3)''
== EMDESCRIPTION: Computes and returns the wavelength-normalized larger dimension of the aperture of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda.Cube's Python Functions for Geometric Object Creation ==
====box({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height[, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom])horn_design_b====
''ExampleSYNTAX: boxhorn_design_b("Box_1"{{ArgTypeReal}} D0_dB,0{{ArgTypeReal}} a_lambda,0,0,50,50,100{{ArgTypeReal}} b_lambda)''
DescriptionEXAMPLE: Draws a box object in the project workspace under the currently activated material group node, or modifies the box named 'label' if it already existshorn_design_b(15,0.4,0.3)''
====cylinder({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom])====DESCRIPTION: Computes and returns the wavelength-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda.
''Example: cylinder("Cylinder_1",0,0,0,10,100)''====horn_design_l====
DescriptionSYNTAX: Draws a cylinder object in the project workspace under the currently activated material group nodehorn_design_l({{ArgTypeReal}} D0_dB, 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.{{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda)
====coneEXAMPLE: ''horn_design_l({{ArgTypeString}} label15, {{ArgTypeAny}} x00.4, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} top_radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]0.3)====''
''ExampleDESCRIPTION: cone("Cone_1",0,0,0,30,40,20,0,180)''Computes and returns the wavelength-normalized length of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda.
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.====huygens_src====
====pyramidSYNTAX: huygens_src({{ArgTypeString}} label, {{ArgTypeAny}} filename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_xx_rot, {{ArgTypeAny}} base_yy_rot, {{ArgTypeAny}} heightz_rot])====
EXAMPLE: ''Example: pyramidhuygens_src("Pyramid_1HS_1","Huygens_1.HUY",1,100,100,0,0,0,10,10,1000)''
DescriptionDESCRIPTION: Draws Creates a pyramid object in Huygens source. If the project workspace under the currently activated material group node, or modifies the pyramid named Huygens source 'label' if it already exists, its properties are modified.
====sphere({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])huygens_surface====
''ExampleSYNTAX: spherehuygens_surface("Sphere_1"{{ArgTypeString}} label,0{{ArgTypeAny}} x1,0{{ArgTypeAny}} y1,0{{ArgTypeAny}} z1,10{{ArgTypeAny}} x2,0{{ArgTypeAny}} y2,180{{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)''
DescriptionEXAMPLE: 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 spherehuygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)''s azimuth axis.
====ellipsoid({{ArgTypeString}} DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y, {{ArgTypeAny}} radius_z[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])====its properties are modified.
''Example: ellipsoid("Ellipsoid_1",0,0,0,100,100,50,0,360)''====huygens_surface_grid====
DescriptionSYNTAX: Draws an ellipsoid object in the project workspace under the currently activated material group node, or modifies the ellipsoid named 'huygens_surface_grid({{ArgTypeString}} 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., {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====torusEXAMPLE: ''huygens_surface_grid({{ArgTypeString}} label"HS_1", {{ArgTypeAny}} x0-10, {{ArgTypeAny}} y0-10, {{ArgTypeAny}} z0-10, {{ArgTypeAny}} radius_major10, {{ArgTypeAny}} radius_minor[10, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]10)====''
DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label'Example: torus("Torus_1"already exists,0,0,0,50,20)''its properties are modified.
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.====hyperbola====
====rect_stripSYNTAX: hyperbola({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side_xdiam_x, {{ArgTypeAny}} side_ydiam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)====
EXAMPLE: ''Example: rect_striphyperbola("my_rectangleHyperbola _1",0,0,0,50,40,20,0)''
DescriptionDESCRIPTION: Draws a rectangle Strip hyperbola object in the project workspace under the currently activated material group node, or modifies the rectangle strip object hyperbola named 'label' if it already exists.If the Boolean parameter "half_only" is 1, only half of the hyperbola will be drawn.
====circ_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} inner_radius, {{ArgTypeAny}} outer_radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])impedance_surface_group====
''ExampleSYNTAX: circ_stripimpedance_surface_group("cs_1"{{ArgTypeString}} label,0{{ArgTypeAny}} z_real,0,0,50,0{{ArgTypeAny}} z_imag)''
DescriptionEXAMPLE: 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 stripimpedance_surface_group("IMP_1",100,-100)''s azimuth axis.
====radial_strip({{ArgTypeString}} DESCRIPTION: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle)====the group is activated.
''Example: radial_strip("Radial_1",0,0,0,50,0,90)''====impenetrable_surface_group====
DescriptionSYNTAX: Draws a radial strip object in the project workspace under the currently activated material group node, or modifies the radial strip object named 'impenetrable_surface_group({{ArgTypeString}} label' if it already exists. , {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
====ellipse_stripEXAMPLE: ''impenetrable_surface_group({{ArgTypeString}} label"Impenet_1", {{ArgTypeAny}} x02.2, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]0.0001)====''
DESCRIPTION: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label'Example: ellipse_strip("es_1"already exists,0,0,0,50,0)''the group is activated.
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.====import_dxf====
====triangle_stripSYNTAX: import_dxf({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} anglefile_name)====
EXAMPLE: ''Example: triangle_stripimport_dxf("ts_1MyDXFModel.DXF",0,0,0,50,100,90)''
DescriptionDESCRIPTION: Draws a triangle strip object in Imports an external DXF model file to the project workspace under . If the currently activated material group nodefile path is not specified, or modifies the triangle strip object named 'label' if it already existscurrent project folder is assumed as the path.
====taper_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo)import_igs====
''ExampleSYNTAX: taper_stripimport_igs("ts_1",0,0,0,50,100,80,1{{ArgTypeString}} file_name)''
DescriptionEXAMPLE: 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 import_igs("is_expo" is 1, an exponential taper will be drawnMyIGSModel. IGS")''
====polygon_reg({{ArgTypeString}} labelDESCRIPTION: Imports an external IGES model file to the project workspace. If the file path is not specified, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides)====the current project folder is assumed as the path.
''Example: polygon_reg("ts_1",0,0,0,50,100,80,1)''====import_py====
DescriptionSYNTAX: 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. import_py({{ArgTypeString}} file_name)
====spiral_stripEXAMPLE: ''import_py({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} width, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual"MyPYModel.PY")====''
''ExampleDESCRIPTION: spiral_strip(Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Spiral _1Documents → EMAG",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. ====import_stl====
====polystripSYNTAX: import_stl({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pnfile_name)====
EXAMPLE: ''Example: polystripimport_stl("ps_1MySTLModel.STL",(0,0,0),(1,0,0),(1,0,0))''
DescriptionDESCRIPTION: Creates or modifies a Polystrip object in Imports an external STL model file to the project workspace. Each point If the file path is represented with a Python tuple type. The poly_strip function not specified, the current project folder is 'self-closing' -- there is no need to supply the first point again at the end of assumed as the point listpath.
====nurbs_strip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)import_stp====
''ExampleSYNTAX: nurbs_stripimport_stp("ns_1",(0,0,0),(1,0,0),(1,0,0){{ArgTypeString}} file_name)''
DescriptionEXAMPLE: 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 listimport_stp("MySTPModel.STP")''
====line({{ArgTypeString}} labelDESCRIPTION: Imports an external STEP model file to the project workspace. If the file path is not specified, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length[, {{ArgTypeAny}} dir])====the current project folder is assumed as the path.
''Example: line("my_line",0,0,0,100,"x")''====inductance====
DescriptionSYNTAX: Draws a Line object in the project workspace under the currently activated material group node, or modifies the line named 'inductance({{ArgTypeString}} label' if it already exists. Without the argument "dir", a vertical line is drawn by default. {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
====circleEXAMPLE: ''inductance({{ArgTypeString}} label"FI_1", {{ArgTypeAny}} x00, {{ArgTypeAny}} y00, {{ArgTypeAny}} z0-10, {{ArgTypeAny}} radius10, {{ArgTypeAny}} start_angle0, {{ArgTypeAny}} end_angle10,2.5,-2.5,0,7.5,2.5,0)====''
DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label'Example: circle("pyramid_1"already exists,0,0,0,10,10,100)''its properties are modified.
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.====inductor====
====superquadSYNTAX: inductor({{ArgTypeString}} label, {{ArgTypeAny}} x0line_object, {{ArgTypeAny}} y0offset, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} orderinductance_nH)====
EXAMPLE: ''Example: superquadinductor("SuperQuad_1Cap_1",0,0,0,50"Line_1",2025,410)''
DescriptionDESCRIPTION: Draws Creates a super-quadratic curve object inductor in [[EM.Tempo]]. If the project workspace under the currently activated material group node, or modifies the super-quadratic curve named inductor 'label' if it already exists. If order = 2, the curve reduces to an ellipse. Higher order make the round edges sharper. An infinite order reduces the curve to a rectangleits properties are modified.
====parabola({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)intersect====
''ExampleSYNTAX: parabolaintersect("Parabola _1"{{ArgTypeString}} label,0{{ArgTypeString}} object_1,0,0,50,20,0{{ArgTypeString}} object_2)''
DescriptionEXAMPLE: 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 intersect("half_onlyIntersection_Object" is 1, only half of the parabola will be drawn. "Rect_Strip1","Rect_Strip2")''
====hyperbola({{ArgTypeString}} DESCRIPTION: Creates a Boolean object named 'label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)====' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.
''Example: hyperbola("Hyperbola _1",0,0,0,50,40,20,0)''====line====
DescriptionSYNTAX: Draws a hyperbola object in the project workspace under the currently activated material group node, or modifies the hyperbola named 'line({{ArgTypeString}} label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the hyperbola will be drawn. {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length[, {{ArgTypeAny}} dir])
====spiral_curveEXAMPLE: ''line({{ArgTypeString}} label"my_line", {{ArgTypeAny}} x00, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00, {{ArgTypeAny}} radius_inner100, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual"x")====''
DESCRIPTION: Draws a Line object in the project workspace under the currently activated material group node, or modifies the line named 'label'Example: spiral_curve(if it already exists. Without the argument "Spiral _1dir",0,0,0,10,50,5,0,0)''a vertical line is drawn by default.
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. ====loft====
====helixSYNTAX: loft({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAnyArgTypeString}} radius_outerobject, {{ArgTypeAny}} nturnsloft_height, {{ArgTypeAny}} helix_dircap_base)====
EXAMPLE: ''Example: helixloft("Helix_1Loft_1",0,0,0,15,15,10"Rect_Strip1",050)''
DescriptionDESCRIPTION: Draws Creates or modifies a helical curve in loft object from a specified object by the project workspace under the currently activated material group nodespecified height. If modifying an existing loft object, or modifies the helix named 'label' if it already existspre-existing primitive is used. The parameter "radius_inner" specifies This command can only loft objects that have a single face and will loft along the helixface'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-clockwisenormal.
====polyline({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)lumped_src====
''ExampleSYNTAX: polylinelumped_src("pl_1"{{ArgTypeString}} label,(0{{ArgTypeAny}} line_object,0{{ArgTypeAny}} offset,0){{ArgTypeAny}} polarity[,(1{{ArgTypeAny}} amplitude,0{{ArgTypeAny}} phase,0),(1,0,0){{ArgTypeAny}} resistance])''
DescriptionEXAMPLE: 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''lumped_src("LS_1", otherwise"Line_1", it is open.50,0)''
====nurbs_curve({{ArgTypeString}} DESCRIPTION: Creates a lumped source in [[EM.Tempo]]. If the lumped source 'label' already exists, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ..its properties are modified. {{ArgType| 3x1 Python tuple}} pn)====
''Example: nurbs_curve("nc_1",(0,0,0),(1,0,0),(1,0,0))''====magnet_group====
DescriptionSYNTAX: 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 pnmagnet_group({{ArgTypeString}} label, otherwise{{ArgTypeAny}} mu, it is open.{{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz)
====pointEXAMPLE: ''magnet_group({{ArgTypeString}} label"Magnet_1", {{ArgTypeAny}} x01, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00,100)====''
DESCRIPTION: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label'Example: point("Point_1"already exists,0,0,10)''the group is activated.
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.====mcos====
====fractal_treeSYNTAX: mcos({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} key_type, {{ArgTypeAny}} key_size, {{ArgTypeAny}} n_level, {{ArgTypeAny}} sep_angle, {{ArgTypeAny}} n_gen, {{ArgTypeAny}} prune_factor, {{ArgTypeAny}} thickness, {{ArgTypeAny}} thick_factorr)====
EXAMPLE: ''Example: fractal_treemcos("Fractal_1",0.5,0,0,"line",10,3,30,3,0,0,02)''
DescriptionDESCRIPTION: Generates a fractal tree in Computes and returns the project workspace under the currently activated material group node, or modifies the fractal tree named 'label' if it already existssuper-quadratic cosine function of order r.
====param_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])mean====
''ExampleSYNTAX: param_curvemean("Curve_1"{{ArgTypeReal}} x,0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t"{{ArgTypeReal}} y)''
DescriptionEXAMPLE: Generates a parametric curve in the project workspace under the currently activated material group node''mean(1, or modifies the parametric curve named 2)'label' if it already exists.
====param_surfaceDESCRIPTION: Computes and returns the arithmetic mean of x and y: 0.5*({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} functionx+y)====.
''Example: param_surface("Surf_1",0,0,0,"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")''====merge_curve====
DescriptionSYNTAX: Generates a parametric surface in the project workspace under the currently activated material group nodemerge_curve({{ArgTypeString}} object_1, or modifies the parametric surface named 'label' if it already exists.{{ArgTypeString}} object_2)
====import_stlEXAMPLE: ''merge_curve({{ArgTypeString}} file_name"Curve_1","Curve_2")====''
''ExampleDESCRIPTION: import_stl("MySTLModelMerges two specified curve objects into a single curve.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.====mesh====
====import_dxfSYNTAX: mesh({{ArgTypeString}} file_name)====
''ExampleDESCRIPTION: import_dxf("MyDXFModelGenerates and displays the mesh of the physical structure.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.====microstrip_design====
====import_stpSYNTAX: microstrip_design({{ArgTypeStringArgTypeReal}} file_namez0, {{ArgTypeReal}} er)====
EXAMPLE: ''Example: import_stpmicrostrip_design("MySTPModel50,2.STP"2)''
DescriptionDESCRIPTION: Imports an external STEP model file Computes and returns the width-to the project workspace. If the file path is not specified, the current project folder is assumed as the path-height ratio of a microstrip transmission line with characteristic impedance z0 in Ohms and substrate relative permittivity er.
====import_igs({{ArgTypeString}} file_name)microstrip_eps_eff====
''ExampleSYNTAX: import_igsmicrostrip_eps_eff("MyIGSModel.IGS"{{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)''
DescriptionEXAMPLE: Imports an external IGES model file to the project workspace''microstrip_eps_eff(2,0. If the file path is not specified5, the current project folder is assumed as the path2.2)''
====import_py({{ArgTypeString}} file_name)====DESCRIPTION: Computes and returns the effective permittivity of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er.
''Example: import_py("MyPYModel.PY")''====microstrip_lambda_g====
DescriptionSYNTAX: Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Documents → EMAG".microstrip_lambda_g({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
====export_stlEXAMPLE: ''microstrip_lambda_g({{ArgTypeString}} file_name2,0.5,2.2,2e9)====''
''ExampleDESCRIPTION: export_stlComputes and returns the guide wavelength ("MySTLModel.STL"in meters)''of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
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.====microstrip_src====
====export_dxfSYNTAX: microstrip_src({{ArgTypeString}} file_namelabel, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====
EXAMPLE: ''Example: export_dxfmicrostrip_src("MyDXFModelMS_1","Rect_1",1.DXF5,"+x")''
DescriptionDESCRIPTION: Exports the physical structure of the project workspacean to Creates a DXF model filemicrostrip port source in [[EM.Tempo]]. If the file path is not specifiedmicrostrip port 'label' already exists, the current project folder is assumed as the pathits properties are modified.
====export_py({{ArgTypeString}} file_name)microstrip_z0====
''ExampleSYNTAX: export_pymicrostrip_z0("MyPYModel.PY"{{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)''
DescriptionEXAMPLE: Exports the physical structure of the project workspace or the current object selection to a Python geometry file''microstrip_z0(2,0. The default path is the Python subfolder under "Documents → EMAG"5,2.2)''
== EMDESCRIPTION: Computes and returns the characteristic impedance (in Ohms) of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er.Cube's Python Functions for Geometric Object Transformation ==
====freeze({{ArgTypeString}} object, {{ArgTypeReal}} freeze_state)microstrip_zoc====
''ExampleSYNTAX: freezemicrostrip_zoc("MyObj"{{ArgTypeReal}} w,1{{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)''
DescriptionEXAMPLE: Sets the freeze state of an object ''microstrip_zoc(2,25,0/1). 5,2.2,2e9)''
====move_toDESCRIPTION: Computes and returns the input reactance ({{ArgTypeString}} objectin Ohms) of an open-circuited microstrip transmission line with width w, {{ArgTypeString}} group_node_label[length l, {{ArgTypeString}} module_name])====substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
''Example: move_to("NewObj","MyObj",10,10,0)''====microstrip_zsc====
DescriptionSYNTAX: Transfers an object from its current material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module. microstrip_zsc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
====cloneEXAMPLE: ''microstrip_zsc({{ArgTypeString}} label2, {{ArgTypeString}} object25, {{ArgTypeReal}} x00.5, {{ArgTypeReal}} y02.2, {{ArgTypeReal}} z02e9)====''
''ExampleDESCRIPTION: cloneComputes and returns the input reactance ("NewObj"in Ohms) of a short-circuited microstrip transmission line with width w,"MyObj"length l,10,10,0)''substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
Description: Creates a copy of the specified object and repositions it at the given coordinates. ====mirror====
====translate_bySYNTAX: mirror({{ArgTypeString}} object, {{ArgTypeRealArgTypeAny}} x_distx0, {{ArgTypeRealArgTypeAny}} y_disty0, {{ArgTypeRealArgTypeAny}} z_distz0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)====
EXAMPLE: ''Example: translate_bymirror("MyObjpyramid_1",100,0,0,1,100,x0)''
DescriptionDESCRIPTION: Translates Mirrors an object in a plane defined by the specified distances in each directionpoint coordinates and specified normal vector components.
====translate_to({{ArgTypeString}} object, {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)move_to====
''ExampleSYNTAX: translate_tomove_to("MyObj"{{ArgTypeString}} object,20 {{ArgTypeString}} group_node_label[,20,x2{{ArgTypeString}} module_name])''
DescriptionEXAMPLE: Translates an object to the specified destination.''move_to("NewObj","MyObj",10,10,0)''
====rotate({{ArgTypeString}} DESCRIPTION: Transfers an object, {{ArgTypeAny}} rot_angle_degree, {{ArgTypeAny}} rot_axis_x, {{ArgTypeAny}} rot_axis_y, {{ArgTypeAny}} rot_axis_z)====from its current material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module.
''Example: rotate("pyramid_1",45,1,1,0)''====msin====
DescriptionSYNTAX: Rotates an object about a line passing through its LCS center and aligned along the specified direction vector msin(rot_axis{{ArgTypeReal}} x, {{ArgTypeReal}} r) by the specified angle.
====scaleEXAMPLE: ''msin({{ArgTypeString}} object0.5, {{ArgTypeAny}} scale_factor2)====''
''ExampleDESCRIPTION: scale("pyramid_1",2)''Computes and returns the super-quadratic sine function of order r.
Description: Scales an object by the specified scale factor.====nurbs_curve====
====get_lengthSYNTAX: nurbs_curve({{ArgTypeString}} objectlabel, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
EXAMPLE: ''Example: get_lengthnurbs_curve("helix_1nc_1",(0,0,0),(1,0,0),(1,0,0))''
DescriptionDESCRIPTION: Returns Creates or modifies a NURBS Curve object in the length of project workspace. Each point is represented with a Python tuple type. The curve objectis closed if p0 is specified again as pn, otherwise, it is open.
====get_area({{ArgTypeString}} object)nurbs_strip====
''ExampleSYNTAX: get_areanurbs_strip("ellipse_1"{{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)''
DescriptionEXAMPLE: Returns the area of a surface object or the total surface area of a solid object.''nurbs_strip("ns_1",(0,0,0),(1,0,0),(1,0,0))''
====get_volume({{ArgTypeString}} 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.
''Example: get_volume("pyramid_1")''====ohmic_loss====
DescriptionSYNTAX: Returns the volume of a solid object.ohmic_loss({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====get_lcsEXAMPLE: ''ohmic_loss({{ArgTypeString}} object"FI_1", {{ArgTypeString}} coordinate-10,-10,-10,10,10,10)====''
DESCRIPTION: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label'Example: get_lcs("pyramid_1"already exists,"x")''its properties are modified.
Description: Returns the specified coordinate of the LCS of an object.====parabola====
====get_rotSYNTAX: parabola({{ArgTypeString}} objectlabel, {{ArgTypeStringArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} coordinatehalf_only)====
EXAMPLE: ''Example: get_rotparabola("pyramid_1Parabola _1","x"0,0,0,50,20,0)''
DescriptionDESCRIPTION: Returns Draws a parabola object in the specified rotation angle 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 an objectthe parabola will be drawn.
====get_extent({{ArgTypeString}} object, {{ArgTypeString}} coordinate)param_curve====
''ExampleSYNTAX: get_extentparam_curve("pyramid_1"{{ArgTypeString}} label,"x"{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])''
DescriptionEXAMPLE: Returns the size of the bounding box of an object along the specified direction''param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")''
====get_vertex({{ArgTypeString}} objectDESCRIPTION: Generates a parametric curve in the project workspace under the currently activated material group node, {{ArgTypeAny}} node_index, {{ArgTypeString}} coordinate)====or modifies the parametric curve named 'label' if it already exists.
''Example: get_vertex("pyramid_1",0,"x")''====param_surface====
DescriptionSYNTAX: 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 0param_surface({{ArgTypeString}} label, while the upper back right corner has an index of 7. The indices are numbered counterclockwise{{ArgTypeAny}} x0, with the bottom face first and top face next. {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function)
====set_rotEXAMPLE: ''param_surface({{ArgTypeString}} object"Surf_1", {{ArgTypeAny}} rot_x0, {{ArgTypeAny}} rot_y0, {{ArgTypeAny}} rot_z0,"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")====''
''ExampleDESCRIPTION: set_rot("pyramid_1",0,0Generates a parametric surface in the project workspace under the currently activated material group node,45)or modifies the parametric surface named 'label'if it already exists.
Description: Sets the three rotation angles of an object.====pec_group====
====set_lcs_linkSYNTAX: pec_group({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_offlabel)====
EXAMPLE: ''Example: set_lcs_linkpec_group("pyramid_1","box_1PEC_1",50,50,0)''
DescriptionDESCRIPTION: Links Creates a PEC material group in the LCS of current module. If the first object to PEC group 'label' already exists, the LCS of the second object by the specified offset values along the three axesgroup is activated.
====set_rot_link({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg)pec_via_group====
''ExampleSYNTAX: set_rot_linkpec_via_group("pyramid_1"{{ArgTypeString}} label,"box_1",0,0,45{{ArgTypeAny}} host_layer)''
DescriptionEXAMPLE: 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.''pec_via_group("PEC_1",10)''
====get_lcs_offset({{ArgTypeString}} objectDESCRIPTION: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off, {{ArgTypeString}} coordinate)====the group is activated.
''Example: get_lcs_offset("box_1",50,50,0,"x")''====pec_voltage_group====
DescriptionSYNTAX: Returns the offset of the LCS of an object along the specified direction.pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)
====mirrorEXAMPLE: ''pec_voltage_group({{ArgTypeString}} object"PEC_1", {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ10)====''
DESCRIPTION: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label'Example: mirror("pyramid_1"already exists,0,0,0,1,0,0)''the group is activated.
Description: Mirrors an object in a plane defined by the specified point coordinates and specified normal vector components.====penetrable_surface_group====
====groupSYNTAX: penetrable_surface_group({{ArgTypeString}} label, {{ArgTypeStringArgTypeAny}} object_1eps, {{ArgTypeStringArgTypeAny}} object_2sigma, ...{{ArgTypeAny}} thickness)====
EXAMPLE: ''Example: grouppenetrable_surface_group("Composite_1Penet_1","Box_1"2.2,"Box_2"0.0001,"Box_3"1)''
DescriptionDESCRIPTION: Groups Creates a number of objects into a composite object with penetrable surface group in [[EM.Terrano]]. If the given penetrable surface group 'label' already exists, the group is activated.
====array({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing)penetrable_volume_group====
''ExampleSYNTAX: arraypenetrable_volume_group("Array_1"{{ArgTypeString}} label,"Rect_Strip_1"{{ArgTypeAny}} eps,4,4,1,50,50,0{{ArgTypeAny}} sigma)''
DescriptionEXAMPLE: Creates or modifies an array object''penetrable_volume_group("Vol_Penet_1",2.2,0.0001)''
====array_custom({{ArgTypeString}} DESCRIPTION: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label' already exists, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)====the group is activated.
''Example: array_custom("Array_1","Rect_Strip_1",4,4,1,50,50,0,100,100,20,0,0,45)''====pipe_sweep====
DescriptionSYNTAX: Creates or modifies an array pipe_sweep({{ArgTypeString}} object and sets its local coordinate system and rotation angles., {{ArgTypeAny}} radius)
====explodeEXAMPLE: ''pipe_sweep({{ArgTypeString}} object"Curve_1",5)====''
''ExampleDESCRIPTION: explode("MyArray")''Creates a pipe version of a given curve object.
Description: Explodes an object into its basic primitives.====planewave====
====subtractSYNTAX: planewave({{ArgTypeString}} label, {{ArgTypeStringArgTypeAny}} object_1theta, {{ArgTypeStringArgTypeAny}} phi, {{ArgTypeAny}} object_2polarization)====
''ExampleEXAMPLE: subtract''planewave("Subtract_ObjectPW_1","Rect_Strip1"180,0,"Rect_Strip2tm")''
DescriptionDESCRIPTION: Creates a Boolean object named 'label' by subtracting object_2 from object_1plane wave source. An error will be thrown if a Boolean object named If the plane wave source 'label' already exists, its properties are modified.
====union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)plot_file====
''ExampleSYNTAX: unionplot_file("Union_Object","Rect_Strip1","Rect_Strip2"{{ArgTypeString}} filename)''
DescriptionEXAMPLE: Creates a Boolean object named 'label' by unioning object_1 and object_2plot_file("D0. An error will be thrown if a Boolean object named DAT")'label' already exists.
====intersect({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)====DESCRIPTION: Plots the contents of a specified data file in EM.Grid.
''Example: intersect("Intersection_Object","Rect_Strip1","Rect_Strip2")''====pmc_group====
DescriptionSYNTAX: Creates a Boolean object named 'pmc_group({{ArgTypeString}} label' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.)
====extrudeEXAMPLE: ''pmc_group({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} extrude_height, {{ArgTypeAny}} cap_ends"PMC_1")====''
DESCRIPTION: Creates a PMC material group in the current module. If the PMC group 'label'Example:extrude("Extrude_1"already exists,"Rect_Strip1",50)''the group is activated.
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.====point====
====loftSYNTAX: point({{ArgTypeString}} label, {{ArgTypeStringArgTypeAny}} objectx0, {{ArgTypeAny}} loft_heighty0, {{ArgTypeAny}} cap_basez0)====
EXAMPLE: ''Example: loftpoint("Loft_1Point_1","Rect_Strip1"0,0,5010)''
DescriptionDESCRIPTION: Creates or modifies Draws a loft object from a specified object by point in the specified height. If modifying an existing loft objectproject workspace under the currently activated material group node, or modifies the pre-existing primitive is used. This command can only loft objects that have a single face and will loft along the facepoint named 'label's normalif it already exists.
====revolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)polygon_reg====
''ExampleSYNTAX: revolvepolygon_reg("Rev1"{{ArgTypeString}} label,"Line_1"{{ArgTypeAny}} x0,0{{ArgTypeAny}} y0,0{{ArgTypeAny}} z0,0{{ArgTypeAny}} radius,0,0,1,360{{ArgTypeAny}} n_sides)''
DescriptionEXAMPLE: Creates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. ''polygon_reg(x0"ts_1",y00,z0) specifies the center of revolution0, and (uX0,uY50,uZ100,80,1) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.''
====consolidate({{ArgTypeString}} 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.
''Example: consolidate("Poly_1")''====polygonize====
DescriptionSYNTAX: Consolidates a specified polygonize({{ArgTypeString}} object., {{ArgTypeAny}} side_length)
====spline_fitEXAMPLE: ''polygonize({{ArgTypeString}} object"Cric_1",2)====''
''ExampleDESCRIPTION: spline_fit("Poly_1")''Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.
Description: Applies spline fit transformation on a specified polymesh, ====polyline or polystrip object.====
====fill_curveSYNTAX: polyline({{ArgTypeString}} objectlabel, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
EXAMPLE: ''Example: fill_curvepolyline("Curve_1pl_1",(0,0,0),(1,0,0),(1,0,0))''
DescriptionDESCRIPTION: Fill the interior of 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 closed curve objectagain as pn, otherwise, it is open.
====merge_curve({{ArgTypeString}} object_1, {{ArgTypeString}} object_2)polymesh====
''ExampleSYNTAX: merge_curvepolymesh("Curve_1"{{ArgTypeString}} label,"Curve_2"{{ArgTypeString}} object, {{ArgTypeAny}} edge_length)''
DescriptionEXAMPLE: Merges two specified curve objects into a single curve.''polymesh("Poly_1","Cric_1",2)''
====close_curve({{ArgTypeString}} label, {{ArgTypeString}} close_state)====DESCRIPTION: Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.
''Example: close_curve("Curve_1",1)''====polystrip====
DescriptionSYNTAX: Sets the open/close state of a polyline or NURBS curvepolystrip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, . Use 0 for open curve and 1 for close curve.. {{ArgType| 3x1 Python tuple}} pn)
====polygonizeEXAMPLE: ''polystrip({{ArgTypeString}} object"ps_1", {{ArgTypeAny}} side_length(0,0,0),(1,0,0),(1,0,0))====''
''ExampleDESCRIPTION: polygonize("Cric_1",2)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.
Description: Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.====port_definition_custom====
====polymeshSYNTAX: port_definition_custom({{ArgTypeString}} label, ({{ArgTypeString}} objectport_1_src_1, {{ArgTypeAnyArgTypeString}} edge_lengthport_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)====
EXAMPLE: ''Example: polymeshport_definition_custom("PD_1",("LS_1","LS_2",50),,("Poly_1LS_3","Cric_1LS_4",250))''
DescriptionDESCRIPTION: Discretizes Creates a custom port definition observable. If the specified solid or surface object by the specified edge length. The results is a polymesh objectobservable 'label' already exists, its properties are modified.
====fillet({{ArgTypeString}} object, {{ArgTypeAny}} radius)port_definition_default====
''ExampleSYNTAX: filletport_definition_default("Rect_1",5{{ArgTypeString}} label)''
DescriptionEXAMPLE: Fillets the corners of the specified surface or curve object by the specified radius.''port_definition_default("PD_1")''
====slice({{ArgTypeString}} objectDESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)====its properties are modified.
''Example: fillet("Rect_1",5)''====probe_gap_src====
DescriptionSYNTAX: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
====roughenEXAMPLE: ''probe_gap_src({{ArgTypeString}} label"Probe_1", {{ArgTypeString}} object"Via_1", {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length0)====''
DESCRIPTION: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label'Example: roughen("Rect_1"already exists,1,5)''its properties are modified.
Description: Roughens the surface of the specified object based on the specified RMS height and correlation length.====pyramid====
====random_groupSYNTAX: pyramid({{ArgTypeString}} label, {{ArgTypeStringArgTypeAny}} key_objectx0, {{ArgTypeStringArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} container_objectbase_y, {{ArgTypeAny}} element_countheight)====
EXAMPLE: ''Example: random_grouppyramid("Rand_1Pyramid_1","Rect_1"0,0,"Box_1"0,10,10,100)''
DescriptionDESCRIPTION: Creates Draws a random group using the specified key pyramid object and confines them in the specified container objectproject workspace under the currently activated material group node, or modifies the pyramid named 'label' if it already exists.
====strip_sweep({{ArgTypeString}} object, {{ArgTypeAny}} width)radial_strip====
''ExampleSYNTAX: strip_sweepradial_strip("Curve_1"{{ArgTypeString}} label,5{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle)''
DescriptionEXAMPLE: Creates a strip version of a given curve object.''radial_strip("Radial_1",0,0,0,50,0,90)''
====pipe_sweep({{ArgTypeString}} DESCRIPTION: Draws a radial strip objectin the project workspace under the currently activated material group node, {{ArgTypeAny}} radius)====or modifies the radial strip object named 'label' if it already exists.
''Example: pipe_sweep("Curve_1",5)''====rail_sweep====
DescriptionSYNTAX: Creates a pipe version of a given curve object.rail_sweep({{ArgTypeString}} rail_object, {{ArgTypeString}} sweep_object)
====EXAMPLE: ''rail_sweep({{ArgTypeString}} rail_object"Curve_1", {{ArgTypeString}} sweep_object"Curve_2")====''
''ExampleDESCRIPTION: rail_sweep("Curve_1","Curve_2")''Rail-sweeps the specified sweep object along the specified curve object.
Description: Rail-sweeps the specified sweep object along the specified curve object.====ramp====
== EM.Cube's Python Functions for Material or Object Group Creation ==SYNTAX: ramp({{ArgTypeReal}} x)
====activateEXAMPLE: ''ramp({{ArgTypeString}} group_node_label0.5)====''
''ExampleDESCRIPTION: activate("Color_1")''Computes and returns the ramp function: x if x>0, 0 if x<0.
Description: Activates a color, material or object group in the current active [[EM.Cube]] module. ====rand====
====color_groupSYNTAX: rand({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeReal}} y)====
EXAMPLE: ''Example: color_grouprand("Color_1"0,1)''
DescriptionDESCRIPTION: Creates Computes and returns a color group in CubeCAD module. If the color group 'label' already exists, the group is activatedrandom number between x and y using an uniform distribution.
====pec_group({{ArgTypeString}} label)random_group====
''ExampleSYNTAX: pec_grouprandom_group("PEC_1"{{ArgTypeString}} label, {{ArgTypeString}} key_object, {{ArgTypeString}} container_object, {{ArgTypeAny}} element_count)''
DescriptionEXAMPLE: Creates a PEC material group in the current module. If the PEC group 'label' already existsrandom_group("Rand_1", the group is activated."Rect_1","Box_1",100)''
====pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)====DESCRIPTION: Creates a random group using the specified key object and confines them in the specified container object.
''Example: pec_voltage_group("PEC_1",10)''====rcs_bistatic====
DescriptionSYNTAX: Creates a fixed-potential PEC object group in the current module. If the PEC group 'rcs_bistatic({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
====pec_via_groupEXAMPLE: ''rcs_bistatic({{ArgTypeString}} label"RCS_1", {{ArgTypeAny}} host_layer1,1)====''
DESCRIPTION: Creates a bistatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label'Example: pec_via_group("PEC_1"already exists,10)''its properties are modified.
Description: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, the group is activated.====rcs_monostatic====
====thinwire_groupSYNTAX: rcs_monostatic({{ArgTypeString}} label, {{ArgTypeAny}} radiustheta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])====
EXAMPLE: ''Example: thinwire_grouprcs_monostatic("Thinwire_1RCS_1",41,1)''
DescriptionDESCRIPTION: Creates a Thinwire material group in the current modulemonostatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the thin wire group observable 'label' already exists, the group is activatedits properties are modified.
====pmc_group({{ArgTypeString}} label)receiver_set====
''ExampleSYNTAX: pmc_groupreceiver_set("PMC_1"{{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)''
DescriptionEXAMPLE: Creates a PMC material group in the current module. If the PMC group 'label' already existsreceiver_set("TX_1", the group is activated"PT_1","DPL_STD.RAD",0,90,0)''
====slot_group({{ArgTypeString}} DESCRIPTION: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label)====' already exists, its properties are modified.
''Example: slot_group("PMC_1")''====rect====
DescriptionSYNTAX: Creates a slot trace group in the current module. If the slot trace group 'label' already exists, the group is activated.rect({{ArgTypeReal}} x)
====dielectric_groupEXAMPLE: ''rect({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho0.1)====''
''ExampleDESCRIPTION: dielectric_group("Dielectric_1","my_eps",Computes and returns the rectangular window function: 1 if x<0,1.5,0)''elsewhere.
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.====rect_gap_src====
====impenetrable_surface_groupSYNTAX: rect_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} epsrect_object, {{ArgTypeAny}} sigmaoffset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====
EXAMPLE: ''Example: impenetrable_surface_grouprect_gap_src("Impenet_1GAP_1",2.2"Rect_1",0,0.0001)''
DescriptionDESCRIPTION: Creates an impenetrable surface group a strip gap circuit source in [[EM.TerranoPicasso]] or [[EM.Libera]]. If the impenetrable surface group strip gap source 'label' already exists, the group is activatedits properties are modified.
====penetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)rect_strip====
''ExampleSYNTAX: penetrable_surface_grouprect_strip("Penet_1"{{ArgTypeString}} label,2.2{{ArgTypeAny}} x0,0.0001{{ArgTypeAny}} y0, 1{{ArgTypeAny}} z0, {{ArgTypeAny}} side_x, {{ArgTypeAny}} side_y)''
DescriptionEXAMPLE: Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'label' already existsrect_strip("my_rectangle", the group is activated.0,0,0,50,20)''
====penetrable_volume_group({{ArgTypeString}} 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, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)====' if it already exists.
''Example: penetrable_volume_group("Vol_Penet_1",2.2,0.0001)''====rename====
DescriptionSYNTAX: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label' already existsrename({{ArgTypeString}} new_label, the group is activated.{{ArgTypeString}} old_label)
====terrain_groupEXAMPLE: ''rename({{ArgTypeString}} label"Box_2", {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma"Box_1")====''
''ExampleDESCRIPTION: terrain_group("Terrain_1",5Deletes a node name from the navigation tree.0The node can be any geometric object, source,0observable or material group.0001)''
Description: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already exists, the group is activated.====resistance====
====base_point_groupSYNTAX: resistance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)====
EXAMPLE: ''Example: base_point_setresistance("BP_Set_1FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)''
DescriptionDESCRIPTION: Creates a base point set resistance integral observable in [[EM.TerranoFerma]]. If the base point set group observable 'label' already exists, the group is activatedits properties are modified.
====virtual_group({{ArgTypeString}} label)resistor====
''ExampleSYNTAX: virtual_groupresistor("VIR_1"{{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} resistance)''
DescriptionEXAMPLE: Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'label' already existsresistor("Res_1", the group is activated."Line_1",25,50)''
====impedance_surface_group({{ArgTypeString}} DESCRIPTION: Creates a resistor in [[EM.Tempo]]. If the resistor 'label' already exists, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)====its properties are modified.
''Example: impedance_surface_group("IMP_1",100,-100)''====revolve====
DescriptionSYNTAX: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'revolve({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)
====conductive_sheet_groupEXAMPLE: ''revolve({{ArgTypeString}} label"Rev1", {{ArgTypeAny}} sigma"Line_1", {{ArgTypeAny}} thickness0,0,0,0,0,1,360)====''
''ExampleDESCRIPTION: conductive_sheet_groupCreates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. ("Cond_1"x0,100y0, 0.01z0)''specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.
Description: Creates a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already exists, the group is activated.====rosen====
====charge_groupSYNTAX: rosen({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} densityy, {{ArgTypeReal}} a, {{ArgTypeReal}} b)====
EXAMPLE: ''Example: charge_grouprosen("Charge_1",-1e-0.5,0,1,2)''
DescriptionDESCRIPTION: Creates a volume charge source group in [[EM.Ferma]]. If Computes and returns the charge group 'label' already exists, the group is activatedRosenbrock function: (a-x)**2 + b*(y-x**2)**2.
====magnet_group({{ArgTypeString}} label, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz)rotate====
''ExampleSYNTAX: magnet_grouprotate("Magnet_1"{{ArgTypeString}} object,1{{ArgTypeAny}} rot_angle_degree,0{{ArgTypeAny}} rot_axis_x,0{{ArgTypeAny}} rot_axis_y,100{{ArgTypeAny}} rot_axis_z)''
DescriptionEXAMPLE: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already existsrotate("pyramid_1", the group is activated.45,1,1,0)''
====volume_current_groupDESCRIPTION: Rotates an object about a line passing through its LCS center and aligned along the specified direction vector ({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jzrot_axis)====by the specified angle.
''Example: volume_current_group("Magnet_1",0,0,1e6)''====roughen====
DescriptionSYNTAX: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'roughen({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length)
====wire_current_groupEXAMPLE: ''roughen({{ArgTypeString}} label"Rect_1", {{ArgTypeAny}} current1, {{ArgTypeAny}} wire_radius5)====''
''ExampleDESCRIPTION: wire_current_group("Magnet_1",1,0Roughens the surface of the specified object based on the specified RMS height and correlation length.5)''
Description: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated.====run_analysis====
== EM.Cube's Python Functions for Source & Lumped Device Definition ==SYNTAX: run_analysis()
====lumped_src({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarityDESCRIPTION: Runs a simulation in the current active [, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance[EM.Cube]])====computational module.
''Example: lumped_src("LS_1","Line_1",50,0)''====save_data====
DescriptionSYNTAX: Creates a lumped source in [[EM.Tempo]]. If the lumped source 'label' already exists, its properties are modified.save_data({{ArgTypeString}} directory_name)
====distributed_srcEXAMPLE: ''save_data({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]"Simulation_Data")====''
''ExampleDESCRIPTION: distributed_src("DS_1","Rect_1","+y","uniform")'Saves [[EM.Cube]]'s output simulation data files under the specified directory.
Description: Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already exists, its properties are modified.====sawtooth====
====microstrip_srcSYNTAX: sawtooth({{ArgTypeStringArgTypeReal}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]x)====
EXAMPLE: ''Example: microstrip_srcsawtooth("MS_1","Rect_1",10.5,"+x")''
DescriptionDESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If Computes and returns the microstrip port 'label' already existsascending periodic sawtooth function of period T = 2, its properties are modifiedoscillating between two values +1 and -1 and having a zero value of at x = 0.
====cpw_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])scale====
''ExampleSYNTAX: cpw_srcscale("CPW_1"{{ArgTypeString}} object,"Rect_1",1.5,"+x"{{ArgTypeAny}} scale_factor)''
DescriptionEXAMPLE: Creates a CPW port source in [[EM.Tempo]]. If the CPW port 'label' already existsscale("pyramid_1", its properties are modified.2)''
====coaxial_src({{ArgTypeString}} label, {{ArgTypeAny}} cylinder_object, {{ArgTypeAny}} outer_radius, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====DESCRIPTION: Scales an object by the specified scale factor.
''Example: coaxial_src("COAX_1","Cyl_1",1.5,"+z")''====select_module====
DescriptionSYNTAX: Creates a coaxial port source in [[EM.Tempo]]. If the coaxial port 'label' already exists, its properties are modified.select_module({{ArgTypeString}} module_name)
====waveguide_srcEXAMPLE: ''select_module({{ArgTypeString}} label, {{ArgTypeAny}} box_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative"[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance[EM.Tempo]]")====''
''ExampleDESCRIPTION: waveguide_src("WG_1","Box_1",50,0)'Selects and sets [[EM.Cube]]'s active module.
Description: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label' already exists, its properties are modified.====set_bandwidth====
====wire_gap_srcSYNTAX: set_bandwidth({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]value)====
EXAMPLE: ''Example: wire_gap_srcset_bandwidth("WIG_1","Line_1",50,01e9)''
DescriptionDESCRIPTION: Creates a wire gap circuit source in Sets [[EM.LiberaCube]]. If the wire gap source 'label' already exists, its properties are modifieds frequency bandwidth.
====rect_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])set_boundary_conditions====
''ExampleSYNTAX: rect_gap_srcset_boundary_conditions("GAP_1"{{ArgTypeString}} xn_type,"Rect_1"{{ArgTypeString}} xp_type,0{{ArgTypeString}} yn_type,0{{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type)''
DescriptionEXAMPLE: Creates a strip gap circuit source in [[EM.Picasso]] or [[EM.Libera]]. If the strip gap source 'label' already existsset_domain_offset_lambda("pml", its properties are modified."pml","pml","pml","pec","pml")''
====probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarityDESCRIPTION: Sets [[EM.Tempo]]'s domain boundary conditions domain offset on the ±X, {{ArgTypeAny}} amplitude±Y and ±Z boundary walls. The options are "pec", {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])===="pmc" and "pml".
''Example: probe_gap_src("Probe_1","Via_1",0)''====set_domain_offset====
DescriptionSYNTAX: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label' already existsset_domain_offset({{ArgTypeAny}} dxn_offset, its properties are modified.{{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)
====wave_portEXAMPLE: ''set_domain_offset({{ArgTypeString}} label20, {{ArgTypeAny}} rect_object20, {{ArgTypeAny}} offset20, {{ArgTypeAny}} is_negative[20, {{ArgTypeAny}} amplitude0, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]10)====''
''ExampleDESCRIPTION: wave_port("WP_1"Sets the domain offset values along the ±X,"Rect_1",0,0)''±Y and ±Z directions in project units.
Description: Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the wave port 'label' already exists, its properties are modified.====set_domain_offset_lambda====
====short_dipoleSYNTAX: set_domain_offset_lambda({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} lengthdxn_offset, {{ArgTypeAny}} uXdxp_offset, {{ArgTypeAny}} uYdyn_offset, {{ArgTypeAny}} uZdyp_offset, {{ArgTypeAny}} amplitudedzn_offset, {{ArgTypeAny}} phasedzp_offset)====
EXAMPLE: ''Example: wave_portset_domain_offset_lambda("SD_1",0.1,0,50,3.1,0.1,0,.1,10,0.25)''
DescriptionDESCRIPTION: Creates a Hertzian short dipole source. If Sets the short dipole source 'label' already existsdomain offset values along the ±X, its properties are modified±Y and ±Z directions in free-space wavelengths.
====planewave({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization)set_frequency====
''ExampleSYNTAX: planewaveset_frequency("PW_1",180,0,"tm"{{ArgTypeAny}} value)''
DescriptionEXAMPLE: Creates a plane wave source. If the plane wave source 'label' already exists, its properties are modifiedset_frequency(2.4e9)''
====gauss_beam({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode)====DESCRIPTION: Sets [[EM.Cube]]'s center frequency.
''Example: gauss_beam("PW_1",180,0,"tm",0,0,0,20,0,0)''====set_lcs_link====
DescriptionSYNTAX: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already existsset_lcs_link({{ArgTypeString}} object, its properties are modified.{{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off)
====huygens_srcEXAMPLE: ''set_lcs_link({{ArgTypeString}} label"pyramid_1", {{ArgTypeAny}} filename["box_1", {{ArgTypeAny}} set_lcs50, {{ArgTypeAny}} polarization50, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot]0)====''
''ExampleDESCRIPTION: huygens_src("HS_1","Huygens_1Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes.HUY",1,100,100,0,0,0,0)''
Description: Creates a Huygens source. If the Huygens source 'label' already exists, its properties are modified.====set_periodic====
====transmitter_setSYNTAX: set_periodic({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_xis_periodic, {{ArgTypeAny}} rot_yspacingX, {{ArgTypeAny}} rot_zspacingY)====
EXAMPLE: ''Example: transmitter_setset_periodic("TX_1","PT_1","DPL_STD.RAD",01,9050,050)''
DescriptionDESCRIPTION: Creates a transmitter set in [[EM.Terrano]]. If Designates the transmitter set 'label' already exists, its properties are modifiedphysical structure as periodic and sets the periods along the X and Y directions.
====resistor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} resistance)set_rot====
''ExampleSYNTAX: resistorset_rot("Res_1"{{ArgTypeString}} object,"Line_1"{{ArgTypeAny}} rot_x,25{{ArgTypeAny}} rot_y,50{{ArgTypeAny}} rot_z)''
DescriptionEXAMPLE: Creates a resistor in [[EM.Tempo]]. If the resistor 'label' already existsset_rot("pyramid_1", its properties are modified.0,0,45)''
====capacitor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pF)====DESCRIPTION: Sets the three rotation angles of an object.
''Example: capacitor("Cap_1","Line_1",25,10)''====set_rot_link====
DescriptionSYNTAX: Creates a capacitor in [[EM.Tempo]]. If the capacitor 'label' already existsset_rot_link({{ArgTypeString}} object, its properties are modified.{{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg)
====inductorEXAMPLE: ''set_rot_link({{ArgTypeString}} label"pyramid_1", {{ArgTypeAny}} line_object"box_1", {{ArgTypeAny}} offset0, {{ArgTypeAny}} inductance_nH0,45)====''
''ExampleDESCRIPTION: inductor("Cap_1","Line_1",25,10)''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.
Description: Creates a inductor in [[EM.Tempo]]. If the inductor 'label' already exists, its properties are modified.====set_stackup_order====
====diodeSYNTAX: set_stackup_order("THS", {{ArgTypeString}} labellabel_1, {{ArgTypeAnyArgTypeString}} line_objectlabel_2, {{ArgTypeAny}} polarity..., {{ArgTypeAnyArgTypeString}} is_fAlabel_n, {{ArgTypeAny}} temperature_K, {{ArgTypeAny}} ideality_factor"BHS")====
EXAMPLE: ''Example: diodebackground_layer("Diode_1THS","Line_1Top_Layer",25"Mid_Layer",0,10"Bottom_Layer",300,1"BHS")''
DescriptionDESCRIPTION: Creates a diode in Sets the hierarchy of [[EM.TempoPicasso]]'s background layer stackup from top to bottom. If The sequence should always start with "THS" standing for the diode 'label' already exists, its properties are modifiedtop 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.
== EM.Cube's Python Functions for Observable Definition ==set_units====
====port_definition_defaultSYNTAX: set_units({{ArgTypeString}} labelunits)====
EXAMPLE: ''Example: port_definition_defaultset_units("PD_1meter")''
DescriptionDESCRIPTION: Creates a default port definition observableSets [[EM. If the observable Cube]]'label' already exists, its properties are modifieds project length units.
====port_definition_custom({{ArgTypeString}} label, ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)sgn====
''ExampleSYNTAX: port_definition_customsgn("PD_1",("LS_1","LS_2",50),,("LS_3","LS_4",50){{ArgTypeReal}} x)''
DescriptionEXAMPLE: Creates a custom port definition observable. If the observable 'label' already exists, its properties are modifiedsgn(-1.0)''
====farfield({{ArgTypeString}} labelDESCRIPTION: Computes and returns the signum function: 1 if x>0, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)====-1 if x<0.
''Example: farfield("FF_1",1,1)''====short_dipole====
DescriptionSYNTAX: Creates a far-field radiation pattern observable. If the observable 'short_dipole({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase)
====rcs_bistaticEXAMPLE: ''short_dipole({{ArgTypeString}} label"SD_1", {{ArgTypeAny}} theta_incr0, {{ArgTypeAny}} phi_incr0,50,3,0,0,1,1,0)====''
DESCRIPTION: Creates a Hertzian short dipole source. If the short dipole source 'label'Example: rcs_bistatic("RCS_1"already exists,1,1)''its properties are modified.
Description: Creates a bistatic RCS observable. If the observable 'label' already exists, its properties are modified.====sigmoid====
====current_distSYNTAX: sigmoidnc({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeReal}} a)====
EXAMPLE: ''Example: current_distsigmoid("CD_1"0.5,1)''
DescriptionDESCRIPTION: Creates a current distribution observable. If Computes and returns the observable 'label' already exists, its properties are modifiedsigmoid function of slope a: 2/(1 + exp(-a*x)) - 1.
====field_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)sinc====
''ExampleSYNTAX: field_sensorsinc("FS_1","z",0,0,0,100,100,0,25,25,0{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modifiedsinc(0.5)''
====field_sensor_gridDESCRIPTION: Computes and returns the sinc function: sin({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0pi*x)====/(pi*x).
''Example: field_sensor_grid("FS_1","z",0,0,0)''====slice====
DescriptionSYNTAX: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already existsslice({{ArgTypeString}} object, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)
====field_probeEXAMPLE: ''slice({{ArgTypeString}} label"Rect_1", {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z05)====''
''ExampleDESCRIPTION: field_probe("FS_1",0,0,50)''Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.
Description: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====slot_group====
====receiver_setSYNTAX: slot_group({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)====
EXAMPLE: ''Example: receiver_setslot_group("TX_1","PT_1","DPL_STD.RADPMC_1",0,90,0)''
DescriptionDESCRIPTION: Creates a receiver set slot trace group in [[EM.Terrano]]the current module. If the receiver set slot trace group 'label' already exists, its properties are modifiedthe group is activated.
====huygens_surface({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)solution_plane====
''ExampleSYNTAX: huygens_surfacesolution_plane("HS_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} field_sensor_label,-10,-10,10,10,10,40,40,40{{ArgTypeAny}} is_quasi)''
DescriptionEXAMPLE: Creates a Huygens surface observable. If the observable 'label' already existssolution_plane("FI_1", its properties are modified."FS_1",1)''
====huygens_surface_grid({{ArgTypeString}} DESCRIPTION: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====its properties are modified.
''Example: huygens_surface_grid("HS_1",-10,-10,-10,10,10,10)''====sphere====
DescriptionSYNTAX: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'sphere({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
====voltage_integralEXAMPLE: ''sphere({{ArgTypeString}} label"Sphere_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x210, {{ArgTypeAny}} y20, {{ArgTypeAny}} z2180)====''
''ExampleDESCRIPTION: voltage_integral("FI_1"Draws a sphere object in the project workspace under the currently activated Material Group node,0,0,-10,0,0,10)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.
Description: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====spiral_curve====
====current_integralSYNTAX: spiral_curve({{ArgTypeString}} label, {{ArgTypeAny}} x1x0, {{ArgTypeAny}} y1y0, {{ArgTypeAny}} z1z0, {{ArgTypeAny}} x2radius_inner, {{ArgTypeAny}} y2radius_outer, {{ArgTypeAny}} z2nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)====
EXAMPLE: ''Example: current_integralspiral_curve("FI_1Spiral _1",-100,-100,0,10,1050,5,0,0)''
DescriptionDESCRIPTION: Creates Draws a current integral observable spiral curve object in [[EM.Ferma]]. If the observable 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, its properties are modifiedthe spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn.
====conduction_current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)spiral_strip====
''ExampleSYNTAX: conduction_current_integralspiral_strip("FI_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} x0,-10{{ArgTypeAny}} y0,0{{ArgTypeAny}} z0,10{{ArgTypeAny}} width,10{{ArgTypeAny}} radius_inner,0{{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)''
DescriptionEXAMPLE: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'label' already existsspiral_strip("Spiral _1", its properties are modified.0,0,0,10,50,5,0,0)''
====capacitance({{ArgTypeString}} 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, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, {{ArgTypeAny}} z4)====a dual-arm spiral curve will be drawn.
''Example: capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)''====spline_fit====
DescriptionSYNTAX: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.spline_fit({{ArgTypeString}} object)
====inductanceEXAMPLE: ''spline_fit({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4"Poly_1")====''
''ExampleDESCRIPTION: inductance("FI_1"Applies spline fit transformation on a specified polymesh,0,0,-10,10,0,10,2polyline or polystrip object.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.====spline2====
====resistanceSYNTAX: spline2({{ArgTypeStringArgTypeReal}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4x)====
EXAMPLE: ''Example: resistancespline2("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,1.0)''
DescriptionDESCRIPTION: Creates a resistance integral observable in [[EM.Ferma]]. If Computes and returns the observable 'label' already exists, its properties are modifiedquadratic B-spline function.
====flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)spline3====
''ExampleSYNTAX: flux_electricspline3("FI_1",-10,-10,5,10,10,10{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modifiedspline3(1.0)''
====flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====DESCRIPTION: Computes and returns the cubic B-spline function.
''Example: flux_magnetic("FI_1",0,0,-10,10,0,10)''====sqr_wave====
DescriptionSYNTAX: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.sqr_wave({{ArgTypeReal}} x)
====energy_electricEXAMPLE: ''sqr_wave({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z20.5)====''
''ExampleDESCRIPTION: energy_electric("FI_1"Computes and returns the periodic square wave function of period T = 2,oscillating between two values +1 and -10,-10,-10,10,10,10)''1 and having a value of +1 at x = 0.
Description: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====sqr2====
====energy_magneticSYNTAX: sqr2({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2y)====
EXAMPLE: ''Example: energy_magneticsqr2("FI_1",-10,-10,-10,10,100,101)''
DescriptionDESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If Computes and returns the observable 'label' already exists, its properties are modifiedsum of squares of x and y: x**2 + y**2.
====ohmic_loss({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)sqr3====
''ExampleSYNTAX: ohmic_losssqr2("FI_1"{{ArgTypeReal}} x,-10{{ArgTypeReal}} y,-10,-10,10,10,10{{ArgTypeReal}} z)''
DescriptionEXAMPLE: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label' already existssqr2(0, its properties are modified.1,2)''
====solution_plane({{ArgTypeString}} labelDESCRIPTION: Computes and returns the sum of squares of x, {{ArgTypeAny}} field_sensor_label, {{ArgTypeAny}} is_quasi)====y and z: x**2 + y**2 + z**2.
''Example: solution_plane("FI_1","FS_1",1)''====sqrt2====
DescriptionSYNTAX: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already existssqrt2({{ArgTypeReal}} x, its properties are modified.{{ArgTypeReal}} y)
== EM.CubeEXAMPLE: ''sqrt2(0,1)''s Python Functions for Simulation-Related Functions & Operations ==
====select_moduleDESCRIPTION: Computes and returns the radius of the 2D point ({{ArgTypeString}} module_namex,y)====: sqrt(x**2 + y**2).
''Example: select_module("[[EM.Tempo]]")''====sqrt3====
DescriptionSYNTAX: Selects and sets [[EM.Cube]]'s active module.sqrt3({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z)
====set_unitsEXAMPLE: ''sqrt3({{ArgTypeString}} units0,1,2)====''
''ExampleDESCRIPTION: set_unitsComputes and returns the radius of the 3D point ("meter"x,y,z)'': sqrt(x**2 + y**2 + z**2).
Description: Sets [[EM.Cube]]'s project length units.====step====
====set_frequencySYNTAX: step({{ArgTypeAnyArgTypeReal}} valuex)====
EXAMPLE: ''Example: set_frequencystep(21.4e90)''
DescriptionDESCRIPTION: Sets [[EM.Cube]]'s center frequencyComputes and returns the unit step function: 1 if x>0, 0 if x<0.
====set_bandwidth({{ArgTypeAny}} value)strip_sweep====
''ExampleSYNTAX: set_bandwidthstrip_sweep(1e9{{ArgTypeString}} object, {{ArgTypeAny}} width)''
DescriptionEXAMPLE: Sets [[EM.Cube]]'s frequency bandwidth.'strip_sweep("Curve_1",5)''
====background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)====DESCRIPTION: Creates a strip version of a given curve object.
''Example: background_layer("Mid_Layer",3.3,0.001,1,1.5)''====subtract====
DescriptionSYNTAX: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.subtract({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)
====delete_background_layerEXAMPLE: ''subtract({{ArgTypeString}} label"Subtract_Object","Rect_Strip1","Rect_Strip2")====''
DESCRIPTION: Creates a Boolean object named 'label'Example: delete_background_layer("Mid_Layer")by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label'already exists.
Description: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.====superquad====
====set_stackup_orderSYNTAX: superquad("THS", {{ArgTypeString}} label_1label, {{ArgTypeStringArgTypeAny}} label_2x0, ...{{ArgTypeAny}} y0, {{ArgTypeStringArgTypeAny}} label_nz0, "BHS"{{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order)====
EXAMPLE: ''Example: background_layersuperquad("THSSuperQuad_1","Top_Layer"0,"Mid_Layer"0,"Bottom_Layer"0,50,"BHS"20,4)''
DescriptionDESCRIPTION: 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 halfDraws a super-space and must end quadratic curve object in "BHS" standing for the bottom halfproject workspace under the currently activated material group node, or modifies the super-spacequadratic curve named 'label' if it already exists. All If order = 2, the intermediate finite-thickness substrate layers must be included and listed in curve reduces to an ellipse. Higher order makes the right round edges sharper. An infinite orderreduces the curve to a rectangle.
====global_ground({{ArgTypeAny}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)taper_strip====
''ExampleSYNTAX: global_groundtaper_strip(1{{ArgTypeString}} label,3.3{{ArgTypeAny}} x0,0.001{{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo)''
DescriptionEXAMPLE: 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 = 'taper_strip("ts_1",0. ,0,0,50,100,80,1)''
====delete({{ArgTypeString}} node_name)====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.
''Example: delete("Box_1")''====terrain_group====
DescriptionSYNTAX: Deletes a node name from the navigation tree. The node can be any geometric objectterrain_group({{ArgTypeString}} label, source{{ArgTypeAny}} eps, observable or material group. {{ArgTypeAny}} sigma)
====renameEXAMPLE: ''terrain_group({{ArgTypeString}} new_label"Terrain_1", {{ArgTypeString}} old_label5.0,0.0001)====''
DESCRIPTION: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label'Example: rename("Box_2"already exists,"Box_1")''the group is activated.
Description: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group. ====thinwire_group====
====zoom_extentsSYNTAX: thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)====
DescriptionEXAMPLE: Zooms to fit the extents of the physical structure into the screen.''thinwire_group("Thinwire_1",4)''
====get_domain_extent({{ArgTypeString}} coordinate)====DESCRIPTION: Creates a Thinwire material group in the current module. If the thin wire group 'label' already exists, the group is activated.
''Example: get_domain_extent("x")''====torus====
DescriptionSYNTAX: Returns the size of the computational domain along the specified direction.torus({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
====set_domain_offsetEXAMPLE: ''torus({{ArgTypeAny}} dxn_offset"Torus_1", {{ArgTypeAny}} dxp_offset0, {{ArgTypeAny}} dyn_offset0, {{ArgTypeAny}} dyp_offset0, {{ArgTypeAny}} dzn_offset50, {{ArgTypeAny}} dzp_offset20)====''
''ExampleDESCRIPTION: set_domain_offset(20Draws an torus object in the project workspace under the currently activated material group node,20,20,20,0,10)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.
Description: Sets the domain offset values along the ±X, ±Y and ±Z directions in project units.====translate_by====
====set_domain_offset_lambdaSYNTAX: translate_by({{ArgTypeAnyArgTypeString}} dxn_offsetobject, {{ArgTypeAnyArgTypeReal}} dxp_offsetx_dist, {{ArgTypeAnyArgTypeReal}} dyn_offsety_dist, {{ArgTypeAnyArgTypeReal}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offsetz_dist)====
EXAMPLE: ''Example: set_domain_offset_lambdatranslate_by(0.1,0.1,0.1"MyObj",0.110,010,0.25x)''
DescriptionDESCRIPTION: Sets Translates an object by the domain offset values along the ±X, ±Y and ±Z directions specified distances in free-space wavelengthseach direction.
====set_boundary_conditions({{ArgTypeString}} xn_type, {{ArgTypeString}} xp_type, {{ArgTypeString}} yn_type, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type)translate_to====
''ExampleSYNTAX: set_domain_offset_lambdatranslate_to("pml"{{ArgTypeString}} object,"pml" {{ArgTypeReal}} x_dest,"pml","pml","pec","pml"{{ArgTypeReal}} y_dest,{{ArgTypeReal}} z_dest)''
DescriptionEXAMPLE: Sets [[EM.Tempo]]'s domain boundary conditions domain offset on the ±X, ±Y and ±Z boundary walls. The options are 'translate_to("pecMyObj", "pmc" and "pml".20,20,x2)''
====add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value)====DESCRIPTION: Translates an object to the specified destination.
''Example: add_variable("MyVar",1)''====transmitter_set====
DescriptionSYNTAX: Adds a new variable to transmitter_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[[EM.Cube]]'s variable list., {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)
====run_analysisEXAMPLE: ''transmitter_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)====''
DescriptionDESCRIPTION: Runs Creates a simulation transmitter set in the current active [[EM.CubeTerrano]] computational module. If the transmitter set 'label' already exists, its properties are modified.
====set_periodic({{ArgTypeAny}} is_periodic, {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY) tri====
''ExampleSYNTAX: set_periodictri(1,50,50{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Designates the physical structure as periodic and sets the periods along the X and Y directions''tri(0.1)''
====save_data({{ArgTypeString}} directory_name) ====DESCRIPTION: Computes and returns the triangular window function: 1-|x| if x<1, 0 elsewhere.
''Example: save_data("Simulation_Data")''====tri_wave====
DescriptionSYNTAX: Saves [[EM.Cube]]'s output simulation data files under the specified directory.tri_wave({{ArgTypeReal}} x)
====plot_fileEXAMPLE: ''tri_wave({{ArgTypeString}} filename0.5) ====''
''ExampleDESCRIPTION: plot_file("D0Computes and returns the periodic triangular wave function of period T = 2, oscillating between two values +1 and -1 and having a value of +1 at x = 0.DAT")''
Description: Plots the contents of a specified data file in EM.Grid.====triangle_strip====
====meshSYNTAX: triangle_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle)====
DescriptionEXAMPLE: Generates and displays the mesh of the physical structure.''triangle_strip("ts_1",0,0,0,50,100,90)''
====emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambdaDESCRIPTION: Draws a triangle strip object in the project workspace under the currently activated material group node, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs)====or modifies the triangle strip object named 'label' if it already exists.
''Example: emtempo_mesh_settings(30,0.1,0.1,0.02)''====union====
DescriptionSYNTAX: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator.union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)
====emillumina_mesh_settingsEXAMPLE: ''union({{ArgTypeAny}} cells_per_lambda"Union_Object","Rect_Strip1","Rect_Strip2")====''
DESCRIPTION: Creates a Boolean object named 'label'Example: emillumina_mesh_settings(30)by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label'already exists.
Description: Sets the parameters of [[EM.Illumina]]'s mesh generator.====virtual_group====
====empicasso_mesh_settingsSYNTAX: virtual_group({{ArgTypeAnyArgTypeString}} cells_per_lambdalabel)====
EXAMPLE: ''Example: empicasso_mesh_settingsvirtual_group(30"VIR_1")''
DescriptionDESCRIPTION: Sets the parameters of Creates a virtual object group in [[EM.PicassoTerrano]]. If the virtual group 's planar hybrid mesh generatorlabel' already exists, the group is activated.
====emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda)voltage_integral====
''ExampleSYNTAX: emlibera_mesh_settingsvoltage_integral(30{{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Libera]]'s mesh generator.'voltage_integral("FI_1",0,0,-10,0,0,10)''
====emferma_mesh_settings({{ArgTypeAny}} cell_size_xDESCRIPTION: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} cell_size_z)====its properties are modified.
''Example: emferma_mesh_settings(0.5,0.5,0.5)''====volume_current_group====
DescriptionSYNTAX: Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator.volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)
====emterrano_mesh_settingsEXAMPLE: ''volume_current_group({{ArgTypeAny}} edge_length"Magnet_1", {{ArgTypeAny}} angle_tol0,0,1e6)====''
DESCRIPTION: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label'Example: emterrano_mesh_settings(5already exists,10)''the group is activated.
Description: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.====wave_port====
====cubecad_mesh_settingsSYNTAX: wave_port({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} edge_lengthphase, {{ArgTypeAny}} angle_tolresistance])====
EXAMPLE: ''Example: cubecad_mesh_settingswave_port(5"WP_1","Rect_1",0,100)''
DescriptionDESCRIPTION: Sets Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the parameters of CubeCADwave port 's mesh generatorlabel' already exists, its properties are modified.
====emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps)waveguide_design====
''ExampleSYNTAX: emtempo_engine_settingswaveguide_design("single-precision"{{ArgTypeReal}} er,-50,20000{{ArgTypeReal}} freq_hertz)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine'waveguide_design(1.0,2e9)''
====emterrano_engine_settingsDESCRIPTION: Computes and returns the minimum larger dimension ({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshholdin meters)====of the cross section of a hollow rectangular waveguide above cutoff with a material filling of relative permittivity er at an operating frequency of freq_hertz.
''Example: emterrano_engine_settings(5,1,1,-100)''====waveguide_src====
DescriptionSYNTAX: Sets the parameters of waveguide_src({{ArgTypeString}} label, {{ArgTypeAny}} box_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[[EM.Terrano], {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]'s SBR simulation engine.)
====empicasso_engine_settingsEXAMPLE: ''waveguide_src({{ArgTypeString}} matrix_solver"WG_1", {{ArgTypeAny}} error_tol"Box_1", {{ArgTypeAny}} max_iterations50,0)====''
DESCRIPTION: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label'Example: empicasso_engine_settings("bicg"already exists,1e-3,1000)''its properties are modified.
Description: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.====wire_current_group====
====emillumina_engine_settingsSYNTAX: wire_current_group({{ArgTypeString}} enginelabel, {{ArgTypeAny}} is_fixed_iterationcurrent, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterationswire_radius)====
EXAMPLE: ''Example: emillumina_engine_settingswire_current_group("ipoMagnet_1",1,0,1e-2,20.5)''
DescriptionDESCRIPTION: Sets the parameters of Creates a wire current source group in [[EM.IlluminaFerma]]. If the wire current group 's Physical Optics simulation enginelabel' already exists, the group is activated.
====emferma_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)wire_gap_src====
''ExampleSYNTAX: emferma_engine_settingswire_gap_src("bicg-stab"{{ArgTypeString}} label,1e-3{{ArgTypeAny}} line_object,100{{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])''
DescriptionEXAMPLE: Sets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines.'wire_gap_src("WIG_1","Line_1",50,0)''
====emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solverDESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label' already exists, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)====its properties are modified.
''Example: emlibera_engine_settings_wmom("bicg",1e-3,1000)''====zoom_extents====
DescriptionSYNTAX: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines.zoom_extents()
====emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} alpha)====DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.
''Example: emlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0.4)''<br />
Description: Sets the parameters of [[EM.Libera]]'s surface MoM simulation engines.<hr>
<p> </p>[[Image:Top_icon.png|48px30px]] '''[[#Standard Python Functions Standard_Python_Operators | Back to the Top of the Page]]'''
[[Image:Back_icon.png|40px30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''