Navigation: Scripting Reference Manual > Functions & Subroutines > AddXYToroidalAsphere

 

AddXYToroidalAsphere

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds an X-Y Toroidal Asphere surface to the associated FRED document.

 

Syntax

n = AddXYToroidalAsphere ( entity, toroid, coefs )

 

Parameters

n (Long)

Node number for the new surface.

 

entity As T_ENTITY

The generic entity data for the new surface.

 

toroid As T_TOROIDALASPHERE

Structure containing data defining the new X-Y Toroidal Asphere surface.

 

coefs() As Double

Array containing aspheric coefficients for the new X-Y Toroidal Asphere surface.

 

Remarks

This function adds a new toroidal asphere surface to the associated FRED document and returns the identifier of the new surface.  If it fails, it posts an error and returns a value of -1.

 

The sag equation of the surface is

 

 

 

where

 

 

 

Cx, Cy are the curvatures in the X and Y directions respectively, and Kx, Ky are the conic constants in the X and Y directions respectively.  The aspheric coefficients Ai are entered into the coefs array in the same order as they appear in the summation above.

 

This surface is similar to Optical Research Associate's XTO,YTO TOROIDAL ASPHERE surface, and Zemax's TOROIDAL surface.

 

See Also

T_ENTITY

T_TOROIDALASPHERE

InitToroidalAsphere

GetXYToroidalAsphere

SetXYToroidalAsphere

GetXYToroidalAsphereCoefCount

GetXYToroidalAsphereIthCoef

SetXYToroidalAsphereIthCoef

Examples

Surfaces

 

 

 

 

 

Copyright © Photon Engineering, LLC