The following is a list of BASIC functions and subroutines that are unique FRED extensions to the scripting language. They are grouped according to common usage.
CloseFred Immediately closes FRED without saving GetDocDir Gets document directory path GetFredVersionIdString Gets FRED version GetUnitConvFactor Returns the scale factor required to convert between the specified spatial units GetUnits Gets document geometry units SysClose Closes the named FRED doc
RepositoryCreate Creates a repository for document control RepositoryCopyFileTo Copies a file to a specified repository RepositoryDeleteFile Deletes a file from specified repository RepositoryMoveFileTo Moves a file to a specified repository RepositoryOpenFileToDoc Opens a FRED file from a specified repository RepositorySaveFredDocTo Saves a FRED document to the specified repository
AddUser2DPlot Adds a new (empty) user 2D chart AddUser2DPlotSeries Adds a new data series to an existing user 2D chart DeleteUser2DPlot Deletes a 2D chart DeleteUser2DPlotSeries Deletes a data series from an existing user 2D chart FindUser2DPlot Returns the plot identification number given a graph title string Get2DChart Retrieves the chart Object for a currently displayed 2D plot and returns the number of currently displayed 2D plots Get3DChartTriplet Retrieves the 3D and two 2D chart objects from an open plot window and returns the number of currently displayed 3D plots GetObjUser2DPlot Returns the 2D chart object for a designated chart GetUser2DPlotGraphTitle Returns the graph title from an existing user 2D chart GetUser2DPlotInfoText Returns the info text string from an existing user 2D chart GetUser2DPlotLegendLabel Returns the legend label string for a data series in an existing 2D chart GetUser2DPlotPoint Retrieves the X,Y value for a point in a given data series GetUser2DPlotPointCount Returns the number of points in a given data series of an existing 2D chart GetUser2DPlotSeries Retrieves the x and y data arrays from a specific series in a 2D chart GetUser2DPlotSeriesCount Returns the number of series currently displayed in an existing user 2D chart GetUser2DPlotWindowTitle Returns the window title string from an existing user 2D chart GetUser2DPlotXAxisTitle Returns the X-axis title from an existing user 2D chart GetUser2DPlotYAxisTitle Returns the Y-axis title from an existing user 2D chart SaveUser2DPlotGraphToFile Saves a bitmap image of an existing user 2D chart SetUser2DPlotGraphTitle Sets the text title for an existing user 2D chart SetUser2DPlotInfoText Sets the info text for an existing user 2D chart SetUser2DPlotLegendLabel Sets the legend label for a series in an existing user 2D chart SetUser2DPlotPoint Sets the X,Y value for a point in a given data series SetUser2DPlotSeries Sets the X and Y data arrays for a given series in an existing user 2D chart SetUser2DPlotXAxisTitle Sets the X-axis text title for an existing user 2D chart SetUser2DPlotXLimits Specifies explicit minimum and maximum limits along the X axis of a user 2D chart SetUser2DPlotXLimitsAuto Specifies the state of the X axis range auto-calculate function of a user 2D chart SetUser2DPlotYAxisTitle Sets the Y-axis text title for an existing user 2D chart SetUser2DPlotYLimits Specifies explicit minimum and maximum limits along the Y axis of a user 2D chart SetUser2DPlotWindowTitle Sets the window title for an existing user 2D chart
MPCRaytrace Performs a GPU raytrace and/or analysis, or renders and image of the 3D view using GPUs MPCAdvancedRaytrace Performs an MPC Trace Advanced calculation using GPUs MPCGetAdvancedParameters Retrieves the advanced parameters and return ray flags used during an Advanced MPC trace MPCGetRaySumMode Retrieves the active state flag and single precision flags of the GPU coherent ray summation mode MPCInitAdvancedRaytrace Initializes a T_MPCADVANCEDRAYTRACE data structure for use with MPCAdvancedRaytrace MPCSetAdvancedParameters Sets the advanced parameters and return ray flags used during an Advanced MPC trace MPCSetRaySumMode Sets the active state flag and single precision flag for the GPU coherent ray summation mode
*IPC = Inter-Process Communication
IPCConnect Issues a connection request to each of the active remote nodes designated in a connections array IPCDeclareTotalWorkUnits Specifies the total number of work units to be distributed across all remote instances IPCDeleteRemoteFile Issues a request to delete a specific file from all active nodes in a connections array IPCDisconnect Issues a disconnect request to all active nodes in a connections array but does not halt or close the associated remote FRED instances IPCExecEmbeddedScript Issues a request to execute an embedded script for all active nodes in a connections array IPCExecScriptFile Issues a request to execute a standalone script for all active nodes in the connections array IPCGetLoadBalance Retrieves the currently assigned load balancing mode IPCGetWorkUnits Used in a remote script, this retrieves the currently assigned work units IPCLoadConfigFile Populates an array of T_IPCINSTANCE (referred to as the "connections array") using remote node information stored in a CSV file IPCLoadModel Issues a request to load a FRED file for all active nodes in the connections array IPCPullFile Pulls (copies) one or more files from the remote nodes to a destination folder (typically on the master node) IPCPushFile Pushes (copies) one or more files from a source folder (typically on the master node) to the remote nodes IPCPushPreferences Pushes the preference settings from the master node out to the remote nodes IPCQueryStatus Queries each of the remote nodes in a connections array for their status and prints the results of the query to the output window IPCReconnect Uses a snap shot file of a previous connections array to re-establish communication with any active nodes IPCRecoverConnections Attempts to use the auto-generated snapshot file in the Undo directory of the master node to reconnect to orphaned remote FRED instances IPCSaveConfigFile Writes the current connections array information to a CSV file for (potentially) use later in reestablishing connections to the remote FRED instances IPCSetLoadBalance Specifies whether load balancing on the remotes should be "static" or "dynamic" IPCTerminate Disconnects and queues all active connections for termination with an optional wait parameter IPCWaitForIdle Instructs the master script to wait a designated amount of time for the active remote nodes to become idle before continuing execution
ClearOutputWindow Clears the output window of text
AddToIsolateAndFit3DView Adds surfaces to an isolated 3D view EnableIsolateFeature Toggles isolate feature on and off GetBackgroundGrid Gets attributes of 3D visualization background grid IsolateAndFit3DView Enables isolated 3D view for surfaces matching the given nodes array RemoveFromIsolateAndFit3DView Removes surfaces from an isolated 3D view SaveJPEGSize Saves the current OpenGL View as a JPEG with a user defined resolution
AccumulateFileInFile Sums separately the components of two data files with matching formats Acos Arc cosine BessJ0 Zeroth order Bessel Function of the first kind BessJn nth order Bessel Function of the first kind BessY0 Zeroth order Bessel Function of the second kind BessYn nth order Bessel Function of the second kind DegToRad Converts a number from degrees to radians GetRandomDouble Returns a high quality random number suitable for multi-threading Min Finds minimum of two numbers Photopic Photopic curve PI Returns the value of PI as 3.14159265358979 PolynomialSolve Fit x,y data to a specific polynomial order and return the coefficients of the fit RadToDeg Converts a number from radians to degrees RanDbl Returns a high quality random number suitable for multi-threading - not limited to scripts associated with FRED documents Round Rounds floating point numbers to integers Scotopic Scotopic curve
Color and Images ChromaticityToCCT Converts chromaticity coordinates to a correlated color temperature (CCT) value ConvertColorImageFileXYZToBitmap Produces a bitmap image from a Color Image data file RGBToBitmap Writes the RGB arrays to a bitmap file TriStimulusToChromaticity Converts visual tristimulus values to chromaticity coordinates XYZImageToRGBImage Converts image array of XYZ tristimulus values to an image array of Red, Green, Blue values
Comments AddComment Appends to doc's comment string Computer Information GetTotalProcessorCount Returns the total number of processors on your computer GetRelativeMaxProcessorCount Returns the number of processors FRED is currently allowed SetRelativeMaxProcessorCount Sets the number of processors FRED is allowed to use
Global Script Variables AddGlobalVar Adds a new global script variable to the document DeleteGlobalVar Deletes a global script variable from the document FindGlobalVar Gets the ID number of a global script variable by its name GetGlobalVar Gets the name, value and comment for a global script variable GetGlobalVarCount Gets the number of global script variables in the document GetGlobalVarValue Gets the value of a global script variable SetGlobalVar Sets the name, value and comment for a global script variable SetGlobalVarValue Sets the value for a global script variable
Library Objects CreateLib Compiles and return a script library object Pre and Post Update Scripts AddPostUpdateScript Appends to document post-update script PrefsGetARNRetainCount Retrieves the preference value controlling the number of ARNs to retain prior to auto-deletion PrefsGetDisplayEnhRaytraceStats Retrieves the preference setting for displaying enhanced raytrace statistics data PrefsGetFGDUseBinaryFormat Retrieves preference to write data files in binary format PrefsGetRandomReseed Retrieves the preference for reseeding the random number generator before every raytrace PrefsSetDisplayEnhRaytraceStats Sets the preference for displaying enhanced raytrace statistics data PrefsSetFGDUseBinaryFormat Sets preference to write data files in binary format PrefsSetARNRetainCount Sets the preference value controlling the number of ARNs to retain prior to auto-deletion ReadPreferences Reads preferences from a text file and applies them SavePreferences Saves currently defined preferences to a text file Shell ShellExecuteAndWait Executes a command in Shell and waits for completion before returning to the FRED script
Text Strings Format Controls formatting of expressions InStrOneOf Finds first occurrence in a string of any character in a character set
Time ElapsedTime Displays the elapsed time since the FRED session started Wait Sleeps for the given number of seconds
Units and Scaling ScaleEntity Scales the designated entity and its descendants by the specified scale factor ScaleToUnits Scales the system to the designated units ScaleSystem Scales the system by a designated value
Updating ForceUpdate Debugging function that forces a full document update. Should only be used in specific cases where the standard Update subroutine does not work properly. RedrawOnUpdate Forces a surface to re-tessellate and redraw
AddEmbeddedScript Adds an Embedded script DeleteEmbeddedScript Deletes Embedded script at given array index FindEmbeddedScript Returns ID of named Embedded script GetEmbeddedScript Gets an Embedded script GetEmbeddedScriptCount Returns the number of Embedded scripts GetEmbeddedScriptDesc Gets the Embedded script description GetEmbeddedScriptLib Returns an Embedded script as a library GetEmbeddedScriptName Gets the Embedded script name SetEmbeddedScript Sets an Embedded script SetEmbeddedScriptDesc Sets the Embedded script description SetEmbeddedScriptName Sets the Embedded script name RunEmbeddedScript Runs an Embedded script
Generic Optimize Initiates an optimization MzrSensitivity Performs a sensitivity analysis on the active optimization variables Merit Function Aberrations EvaluateMeritFunction Evaluates and returns the Merit Function value GetMzrAberrationTarget Retrieves the target value from a merit function aberration InsertIthMzrAberration Inserts a Merit Function aberration IsMzrAllowARNs Returns a boolean indicating whether ARN generation by detector entities during optimization raytracing is allowed SetMzrAberrationTarget Sets the target value for a specific merit function aberration SetMzrAllowARNs Specifies whether ARN generation by detector entities should be allowed during optimization raytracing Optimization Method GetMzrAnnealStartTemperature Returns the starting temperature for a simulated annealing optimization GetMzrAnnealStopAfterSteps Returns the number of temperature reduction steps for a simulated annealing optimization GetMzrAnnealStopBelowMinTemperature Returns the minimum temperature stopping criteria for a simulated annealing optimization GetMzrAnnealTemperatureReduceFraction Returns the temperature reduction fraction value for a simulated annealing optimization GetMzrMethod Returns the Optimization Method GetMzrMultiStarts Returns the number of multiple restarts allowed in an optimization GetMzrRedraw3DViewCount Returns the number of iterations to be skipped between redraws of the 3D View
IsMzrHaltOnMeritError Returns True if Optimization is to be halted on a merit function error IsMzrLogBeforeAndAfter Returns True if variable and aberration value before and after optimization logging is active IsMzrLogMeritFunctions Returns True if Merit Function values are to written to the Output Window IsMzrLogVerboseMeritFunc Returns True if the verbose output is active or False if inactive
SetMzrAnnealStartTemperature Sets the starting temperature for a simulated annealing optimization SetMzrAnnealStopAfterSteps Sets the stopping criteria in a simulated annealing optimization to use a designated number of steps SetMzrAnnealStopBelowMinTemperature Sets the stopping criteria in a simulated annealing optimization to use a designated minimum temperature SetMzrAnnealTemperatureReduceFraction Sets the temperature reduction fraction value for a simulated annealing optimization SetMzrLogBeforeAndAfter Sets the flag to log variable and aberration values from before and after optimization for printing to the output window SetMzrLogMeritFunctions Sets the flag to allow Merit Function values to be written to the Output Window SetMzrLogVerboseMeritFunc Sets the active flag for the verbose merit function calculation output SetMzrMultiStarts Sets the number of multiple random restarts for an optimization SetMzrRedraw3DViewCount Sets the number of iterations to be skipped between redraws of the 3D View SetMzrRedrawRays Specifies whether the rays should be redrawn during optimization SetMzrRedrawRaysCount Sets the number of iterations to be skipped between redraws of the rays SetMzrStopVarChange Sets the Stopping/Convergence Criteria "variable changes less than" SetMzrStopOnIterCount Sets the Stopping/Convergence Criteria "after iterations" SetMzrVariableSoftBoundary Specifies whether the soft-limit penalty should be applied when variables range out of bounds Optimization Results DeleteMzrResult Deletes the optimization result from the results list DeleteMzrResultAll Deletes all optimization results from the results list GetMzrResult Retrieves a result from the specified index in the results list GetMzrResultCount Retrieves the number of optimization results in the results list
Optimization Variables GetMzrVariableCount Returns the number of Optimization Variables
AddPickup Adds a new parameter pickup to the document pickup list DeletePickup Deletes the pickup entry at the specified index in the document pickup list GetPickup Retrieves the pickup entry definition at the specified index and stores the result in a T_PICKUP structure GetPickupCount Returns the number of entries in the pickup list GetPickupsActiveFlag Retrieves the active flag status for parameter pickups InitPickup Initializes a T_PICKUP data structure with default values SetPickup Sets the parameter values for a pickup entry in the document pickup list SetPickupsActiveFlag Sets the active flag status for parameter pickups
AddConfig Adds a new configuration to the end of the configuration list AddConfigVariable Adds a new configuration variable DeleteConfigVariable Deletes the configuration variable at the designated index DeleteIthConfig Deletes the configuration at the designated index GetConfigCount Returns the number of configurations defined in the document GetConfigValue Retrieves the variable value for a given configuration GetConfigVariable Retrieves a specified configuration variable definition GetConfigVariableCount Returns the number of variables in the configuration list GetCurrentConfig Returns the configuration number that the document is currently in InitConfigVariable Initializes a T_CONFIGURATION data structure with default member values InsertIthConfig Inserts a new configuration at the designated index SetConfigValue Sets the configuration value for a given variable and configuration SetConfigVariable Sets the parameter values for an existing configuration variable SetCurrentConfig Sets the document state to a current configuration
AddGroup Appends new group DeleteAllGroups Deletes all groups FindEntityInGroup Find entity id, 'i', in n'th group GetFromNthGroup Gets i'th item from n'th group SetGroupDescription Sets the description of the n'th group
DoCADExport Executes an export of the model to a CAD file DoCADImport Executes an import of CAD geometry into the associated document InitCADImport Initializes a T_CADIMPORT data structure with default member values InitCADExport Initializes a T_CADEXPORT data structure with default member values
Add Primitive ElemAddBeveledWedge Adds a Beveled Wedge type element primitive ElemAddBlock Adds a Block type element primitive ElemAddCircularPyramid Adds a Circular Pyramid type element primitive ElemAddCoil Adds a Coil type element primitive ElemAddCPC Adds a CPC type element primitive ElemAddCube Adds a Cube type element primitive ElemAddCylinder Adds a new Cylinder type element primitive ElemAddCylinderLens Adds a Cylinder Lens type element primitive ElemAddEllipsoid Adds an Ellipsoid type element primitive ElemAddEllipsoidTrunc Adds a Truncated Ellipsoid type element primitive ElemAddFrustum Adds a Frustum type element primitive ElemAddHemisphereShell Adds a Hemisphere Shell type element primitive ElemAddHemisphereSolid Adds a Hemisphere Solid type element primitive ElemAddHemisphereSurface Adds a Hemisphere Surface type element primitive ElemAddIdealLens Adds an Ideal Lens type element primitive ElemAddMultimodeFiberOptic Adds a Multimode Fiber Optic type element primitive ElemAddNsidedExtrudedSolid Adds an N-sided Extruded Solid type element primitive ElemAddNsidedExtrudedSurface Adds an N-sided Exttruded Surface type element primitive ElemAddNsidedPipe Adds an N-sided Pipe type element primitive ElemAddNsidedPlane Adds an N-sided Plane type element primitive ElemAddNsidedPyramidSolid Adds an N-sided Pyramid Solid type element primitive ElemAddParabolicTrough Adds a Parabolic Trough type element primitive ElemAddParaboloid Adds a Paraboloid type element primitive ElemAddPipe Adds a Pipe type element primitive ElemAddPlane Adds a Plane type element primitive ElemAddPlaneWithNsidedHole Adds a Plane with N-sided Hole type element primitive ElemAddRod Adds a Rod type element primitive ElemAddSphere Adds a Sphere type element primitive ElemAddTorus Adds a Torus type element primitive ElemAddWedge Adds a Wedge type element primitive
Parameters ElemGetCPC Retrieves the construction data from a CPC element primitive into a data structure ElemGetParmCount Gets the number of parameters used to define the element primitive ElemGetParmDescription Gets the description of an element primitive parameter ElemGetParmName Gets the name of an element primitive parameter ElemGetParmValue Gets the value of an element primitive parameter ElemSetCPC Sets the construction data for a CPC element primitive using a data structure ElemSetParmValue Sets the value of an element primitive parameter
Properties ElemAddScatter Adds a scatter model to all surfaces in the element primitive ElemSetCoating Sets the coatings for all surfaces in the element primitive ElemSetMaterials Sets the materials for all surfaces in the element primitive ElemSetRaytraceCtrl Sets the raytrace control set for all surfaces in the element primitive
Status IsElementPrimitive Checks to see if a node is, or is not, an element primitive
ElemAddBoolean Adds an element composite do the document ElemBooleanGetSpec Gets the boolean operation string from an element composite ElemBooleanSetSpec Sets the boolean operation string for an element composite
Advanced InitAdvancedRaytrace Initializes the advanced raytrace variable type TargetedRay Performs the targeted ray trace Basic TraceCreate Creates all, trace, and no draw
Ray buffer handling AddRayBuffer Adds a ray buffer to the main raybuffer array CopyRayAuxBufferToBuffer Copies a ray from an aux ray buffer to the main ray buffer CopyFilteredRaysBufferToBuffer Copies, in bulk, all rays passing an array of ray selection filter criteria from one buffer to another CopyRayBufferToBuffer Copies a ray from one ray buffer to another GetActiveRayBufferIndex Returns the raybuffer array index of the active ray buffer GetAuxRayBufferCount number of ray buffers in the auxiliary ray buffer array GetAuxRayBufferRayCount number of rays in the n'th auxiliary ray buffer GetRayBufferRayCount number of rays in the n'th ray buffer GetTracingRay Retrieves the T_RAY structure corresponding to the ray currently being traced in the ray buffer SetTracingRay Sets the T_RAY structure member variable values to the ray currently being traced in the ray buffer
BestFocus Performs a Geometric Best Focus analysis in a user-specified coordinate system CalcOPDMapsAuto Performs a Geometric OPD Map analysis with FRED auto-determining the best-fit reference sphere CalcOPDMapsCurve Performs a Geometric OPD Map analysis with a user-defined reference sphere specified using a curvature and tilt vector CalcOPDMapsFocus Performs a Geometric OPD Map analysis with a user-defined reference sphere specified as the sphere's x,y,z center position CoherentRaySize Gaussian beam size (e^-2 power) ColorImageToARN Performs a Color Image analysis and stores the result in an ARN ColorImageToFile Performs a Color Image analysis and writes the result directly to a file ColorImageToFileAS A variation of ColorImageToFile that leverages an Analysis Surface for grid and ray filtering specification ConvertColorImageFileXYZToBitmap Produces a bitmap image from a Color Image data file. DecomposeWavefrontToZernikes Computes Zernike coefficients for a wavefront EnergyDensity Computes energy density EnergyDensityToARN Computes Energy Density and return results to an ARN EnergyDensityToFile Computes Energy Density and write result to file EnergyDensityToFileAS Computes Energy Density write result to file using only Analysis Surface settings FiberCoupleStepIndex Computes fiber coupling coefficient for a step index single core fiber GetSurfIncidentRayCount Returns the number of rays incident on a surface during the most recent raytrace IlluminanceToARN Computes illuminance and return to an ARN IlluminanceToFileAS Computes illuminance and write to a file IntensityAtSpecifiedDirections Computes intensity or luminous intensity at user specified directions given an acceptance cone size IntensityToARN Computes Intensity in polar coordinates and returns results to an ARN IntensityToFileDAE Computes Intensity in polar coordinates Irradiance Computes irradiance IrradianceToARN Computes irradiance and store results in an ARN IrradianceToFile Computes irradiance and write to file IrradianceToFileAS Computes irradiance and write to file using only Analysis Surface settings LuminousIntensityToFileDAE Computes the luminous intensity using a DAE and write the results to a file RaySummaryInfo Computes the ray summary information and store the results in a dictionary object ScalarFieldToARN Computes a complex scalar field and return results to an ARN ScalarFieldToFile Computes a complex scalar field and write to file ScalarFieldToFileAS Computes a complex scalar field and write to file using only Analysis Surface settings SpectralAnalysis Performs a spectral analysis and creates a spectrum node containing the result SurfPowers Prints incident/absorbed ray powers VectorFieldToARN Computes a complex vector field and return results to an ARN VectorFieldToFile Computes a complex vector field and write to file VectorFieldToFileAS Computes a complex vector field and write to file using only Analysis Surface settings Wavefront Computes wavefront from a complex scalar field WavefrontToARN Computes the wavefront of a complex scalar field and stores the result in an ARN WriteToPlotFileWithComment - Writes sample analysis data to 3D chart compatible file with text comments included Data Collector Surface Visualization
IsDataCollectorSurf Query a surface to determine if it is a data collector surface object
DataCollectorPropertiesInit Initializes the members of a T_COLLECTOR_PROPERTIES data structure DataCollectorPropertiesGet Retrieves the property configuration of the Data Collector Surface Visualization analysis function DataCollectorPropertiesSet Sets the property configuration of the Data Collector Surface Visualization analysis function
DataCollectorSurfIsDataAvailable Queries a data collector surface to check if the collector is initialized DataCollectorSurfIsCollectData Retrieves the data collection Active flag status of a data collector surface object DataCollectorSurfSetCollectData Sets the Active flag state of a data collector surface object DataCollectorSurfGetDataStats Retrieves the Active flag state of a data collector surface object
DataCollectorSurfGetDatum Retrieves a datum from a specific facet ID of a data collector surface object DataCollectorSurfGetDatumCount Retrieves the number of datum from a data collector surface object DataCollectorSurfSetDatum Applies a datum to a specific facet ID of a data collector surface object
DataCollectorSurfReadCollectedDataFile Reads datum from a CSV file into the facets of a data collector surface object DataCollectorSurfWriteCollectedDataFile Writes datum from facets of a data collector surface object into a CSV file
Analysis Surfaces AddAnalysisSurf Adds an analysis surface GetAnalysisSurf Gets analysis surface GetRayFilter Retrieves all ray filter operations from an analysis surface and populates an array of T_RAYFILTEROP data structures LoadAnalysis Loads T_ANALYSIS structure with appropriate data from 'nEntity' SetAnalysisParameters Sets T_ANALYSIS parameters SetAnalysisSurf Sets analysis surface
Directional Analysis Entities AddDirAnaEntity Adds a Directional Analysis Entity AddDirAnaEntityOp Adds a Ray Specification to a Directional Analysis Entity DeleteDirAnaEntityIthOp Deletes a Ray Specification from a Directional Analysis Entity GetDirAnaEntityAutoScale Returns the autoscale parameter setting for a Directional Analysis Entity GetDirAnaEntityAxes Returns the Axes parameter setting for a Directional Analysis Entity GetDirAnaEntityAzimuthalRange Returns the Azimuthal Range settings for a Directional Analysis Entity GetDirAnaEntityDrawProperties Returns the Draw Properties for a Directional Analysis Entity GetDirAnaEntityIthOp Returns the Ith Ray Specification from a Directional Analysis Entity GetDirAnaEntityOpCount Returns the number of Ray Specifications for a Directional Analysis Entity GetDirAnaEntityPolarRange Returns the Polar Range setting for a Directional Analysis Entity IsDirectionalAnalysisEntity Checks if a given node is a Directional Analysis Entity SetDirAnaEntityAutoScale Sets the autoscale parameter for a Directional Analysis Entity SetDirAnaEntityAxes Sets the Axes parameter for a Directional Analysis Entity SetDirAnaEntityAzimuthalRange Sets the Azimuthal Range for a Directional Analysis Entity SetDirAnaEntityDrawProperties Sets the Draw Properties for a Directional Analysis Entity SetDirAnaEntityIthOp Sets the Ith Ray Specification for a Directional Analysis Entity SetDirAnaEntityPolarRange Sets the Polar Range for a Directional Analysis Entity
DEAddOp Adds a ray filter operation to a detector entity DECreate Adds a new detector entity to the document DEDeleteIthOp Deletes a specific ray filter operation from a detector entity DEGetIthOp Retrieves a specific ray filter operation from a detector entity DEGetMostRecentARNNum Returns the node number of the most recent ARN created by a detector entity DEGetOpCount Returns the number of ray filter operations applied to a detector entity DEGetParam Returns the value of a specific detector entity parameter DEGetParamNames Populates a string array with all of the parameter names for a specific detector entity DEGetParams Returns a single string containing all parameter name and value pairs for a detector entity DEGetType Returns the type string for a specific detector entity DEPerformAnalysis Performs the analysis for a detector entity DESetIthOp Sets a specific ray filter operation for a detector entity DESetParam Sets a single parameter value for a detector entity DESetParams Sets one or more parameter values simultaneously for a detector entity IsDetectorEntity Checks if a node is a detector entity
ARN Data Computations ARNAccumulate Linearly combines one or more ARNs together with scaling factors and returns a new ARN containing the resulting data ARNAverageAlongAAxis Sets each cell in a row along the A-axis to be the average for that row ARNAverageAlongBAxis Sets each cell in a row along the B-axis to be the average for that row ARNCompute2DCellStatistics Calculates the statistics of the data contained in an ARN ARNCompute3DGridWallCellStatistics Calculates the statistics of the data contained in a 3D Grid Wall ARN ARNComputeCCT Calculates Correlated Color Temperature from a Color Image ARN ARNComputeIntegral Calculates the integral value (cell value*cell area for all cells) of the data in a 2D ARN and returns the result ARNComputeStandardDev Calculates the standard deviation of the cell values in a 2D ARN and returns the result ARNComputeSum Performs a summation of all cell values in a 2D ARN and returns the result ARNComputeTotalPower Calculates the total power for the data contained in an ARN ARNComputeWavefront Extracts the wavefront data array from a scalar field type ARN ARNDecomposeToZernikes Performs a Zernike decomposition on an ARN with single-valued cell data of type Double ARNFFT2D Performs a two dimensional FFT on an ARN in place (no copy is made) ARNInterpolateCellValue3D Interpolates the value at position x,y,z from a 3D Grid Wall type ARN ARNInterpolateCellValue2D Interpolates the value at position x,y from a 2D ARN ARNLinearCombination Linearly combines exactly two ARNs together with scale factors ARNLog10WithAbsoluteFloor Logs the data in an ARN and specify an absolute floor value below which the log is not taken ARNLog10WithRelativeFloor Logs the data in an ARN and specify a floor value relative to the peak of the data
ARN Node Information ARNGetLocked Queries an ARN for its lock status ARNGetMaxNodeNum Gets maximum ARN node number ARNSetLocked Sets the lock status for an ARN
Creating an ARN ARNCreate2DGrid Creates an ARN data format ARNCreate2DSubsetByCellIndices Creates a new 2D ARN from a subset of data in an existing 2D ARN by specifying axes index ranges ARNCreate2DSubsetByRange Creates a new 2D ARN from a subset of data in an existing 2D ARN by specifying axes value ranges ARNCreate2DComplexFromDouble Creates a new 2D ARN with complex valued data (i.e. scalar field) from an existing ARN whose data type is Double ARNCreate2DDoubleFromComplex Creates a new 2D ARN with data type Double from an existing ARN whose data type is complex (i.e. scalar field) by extracting a specified field component ARNCreateCopy Creates a copy of an existing ARN ARNCreateFromDirectory Searches a directory path for *.fgd and *.dat files and creates ARNs from all identified files ARNCreateFromFile Creates ARN from FRED Grid Data file (*.fgd)
Displaying an ARN ARNCancelDisplayInVisualizationView Removes an ARN from display in the 3D view ARNDisplayInChart Displays an ARN in FRED's chart view ARNDisplayInChartTriplet Displays an ARN in a chart window and return the 3D and 2D chart objects, allowing customization of the charts ARNDisplayInVisualizationView Displays an ARN in FRED's 3D visualization viewer for context ARNSetDisplayScale Sets the color range scaling for one or more ARNs being displayed in the 3D visualization viewer
Finding / Deleting an ARN ARNDelete Deletes given ARN ARNFindName Finds node number of named ARN
Get / Set ARN Name and Description ARNGetDescription Gets text description from given ARN ARNGetName Gets name of given ARN node
Get / Set ARN Information ARNAppendToInfo Appends to info in existing ARN ARNGetAAxisDim Gets A-axis dimension of existing ARN ARNGetCAxisDim Gets the dimension of the C-axis ARNGetCAxisDir Gets the unit vector direction of the C-axis for an existing ARN (3D results only) ARNGetCAxisParams Gets the C-axis parameters of an existing ARN (3D results only) ARNGetCAxisRange Gets C-axis range for an existing ARN (3D results only) ARNGetCAxisValueAt Retrieves the C-axis value at the given index in the ARN (3D results only) ARNGetCellIndicesClosestToLocation2D Retrieves the A and B axis index positions which are closest to a designated physical location in the grid ARNGetDataSpatialUnits Retrieves the data spatial units string from an existing ARN ARNGetDataType Gets ARN data type ARNGetPlaneCenter Returns the center coordinates of ARN ARNGetPowerUnits Returns the ARN's power units string ARNGetTagValueAsDoubleArray Gets a tag value as a double array ARNSetDataSpatialUnits Sets the data spatial units for an existing ARN ARNSetPowerUnits Sets the power units string of an existing ARN ARNSetTagValueAsDouble Sets a tag value as a double ARNSetTagValueAsDoubleArray Sets a tag value as a double array ARNSetTagValueAsInt Sets a tag value as an int ARNSetTagValueAsString Sets string value of user-defined tag
Get / Set ARN Data ARN3DGridWallGetAbsorbedFluxData Gets the AbsorbedFlux cell data from a 3D Grid Wall analysis results node as a three dimensional array of doubles ARN3DGridWallGetInCountData Gets the cell ray counts for InFlux contributors from a 3D Grid Wall analysis results node as a three dimensional array of longs ARN3DGridWallGetInFluxData Gets the InFlux cell values from a 3D Grid Wall ARN and stores them in a 3D array ARN3DGridWallGetOutCountData Gets the cell ray counts for OutFlux contributors from a 3D Grid Wall analysis results node as a three dimensional array of longs ARN3DGridWallGetOutFluxData Gets the OutFlux cell values from a 3D Grid Wall ARN and stores them in a 3D array ARNGetCellValueAsDoubleArray2D Gets multi-dimensional cell values and stores them in a 2D array ARNGetDataAsDoubleArray Gets data from ARN into double array ARNGetHoleValueAsDoubleArray Gets Hole value ARNSetDataAsDoubleArray Sets data into ARN double array ARNSetHoleValueAsDoubleArray Sets hole value
Multi-slice ARNs ARNCombineIntoMultiSlice Combines one or more 2D ARNs into a single multi-slice ARN ARNCreateSlice2DGrid Creates a new slice in an ARN with an empty data grid ARNCreateSliceCopy Creates a copy of the active slice from one ARN and places it into a destination ARN ARNGetActiveSlice Retrieves the active slice index from an ARN ARNGetSliceCount Retrieves the number of slices in an ARN ARNMoveSliceFromARN Moves the active slice from one ARN into a destination ARN ARNRemoveSlice Removes the active slice from an ARN ARNReorderSlices Specifies a new ordering for the slices within an ARN ARNSetActiveSlice Specifies the slice index that should become the active slice in an ARN ARNShuffleSliceTo Moves the active slice of an ARN to a new index position within the same ARN
Writing to File ARNSaveToFITS Writes ARN data to a Flexible Image Transport System (FITS) file ARNSaveToImage Writes ARN data to BMP, JPEG, GIF or TIFF image files ARNSaveToVideo Writes multiple ARNs (or all all slices of a multi-slice ARN) to an output video file ARNExportToBOVFiles Writes the cell data in a 3D Grid Wall type analysis results node to a set of BOV files ARNExportToLMAFile Writes the cell data in a 3D Grid Wall type analysis results node to an LMA file ARNExportToVTKFile Writes the cell data in a 3D Grid Wall type analysis results node to a VTK file ARNWriteToFile Writes ARN contents to FRED Grid Data file (*.fgd)
CopyEntity Creates a copy of a given entity DeleteEntity Deletes the entity and its descendants recursively Find Finds a Source entity, Geometry entity, or Analysis Surface entity with the given base name FindFullName Returns id number of the entity with the given full name (unique) FindText Searches node names/descriptions for the given text GetChild Returns array index of child (-1 if no child) GetParent Returns array index of parent (-1 if no parent)
FindColorScheme Finds index of given color scheme GetAxesDrawable Axes drawable flag GetColorSchemeCount Gets Color Scheme count GetColorSchemeName Gets Color Scheme name GetEntity Gets general info InitEntity Initializes a T_ENTITY structure with default values ListColorSchemes Lists all color schemes SetColorSchemeByIndex Sets color scheme for given entity by index SetColorSchemeByName Sets color scheme for given entity by name SetDescription Sets the description of an entity SetName Sets the name of an entity SetParent Sets an entity's parent
Entity Arrays DeleteEntityArray Deletes the "array" property from the entity GetEntityArray Gets entity array info InitEntityArray Initializes a T_ENTITYARRAY structure with default values SetEntityArray Sets entity array info
Basic Geometric Ray Handling ApplyFilterToRays Applies an array of T_RAYFILTEROP data structures to the active ray buffer DeleteRay Deletes a geometric ray GetRay Gets the n'th ray's geometric data PrintRayFilter Prints a text summary of an array of T_RAYFILTEROP data structures to the output window or to an output text file ReverseRays Reverses the trajectory of all active rays SetRay Sets the n'th ray's geometric data
Ray Buffer Ray Count GetLiveRayCount Returns the actual number of live (nonzombie/nonhole) rays in the ray buffer GetRayCount Returns the number of rays in the ray buffer
Ray Buffer Compaction
Ray Data Retrieval GetRayDiffractDepth Returns the number of diffraction events that a ray has undergone GetRayIncidentOrDepartureAngle Calculates the incident or departure angle in degrees for a given ray GetRayIncidentOrDepartureSidedness Calculates whether a ray is incident on (or departing from) the positive or negative surface normal side of its current surface GetRayInitialPower Returns n'th ray's starting power GetRayOrdinaryExtraType Returns a string indicating whether the ray is an ordinary or extraordinary ray in the context of its current immersion material GetRayWavelength Ray wavelength (mm) GetRayWaveVector Queries a ray for the direction components of its wave vector. IsRayAbsorbed Returns True if n’th ray is an absorbed ray IsRayActive Returns True if n’th ray is active RayScalarFieldAtPoint Retrieves the real and imaginary field contributions at a given (xyz) point in space for the beamlet of a specified (base) ray
Ray Data Setting SetRayX Sets the n'th Ray's X coordinate
Ray History IsRayHistory Returns a True/False indicating whether ray history information is available RedrawRayHistory Redraws ray history for all rays meeting the supplied ray selection criteria requirements SaveRayHistory Saves the current ray history information to a text file
Ray Iteration GetFirstFilteredRay Retrieves the first ray in the buffer passing a ray selection filter criteria GetFirstRay Ray forward iteration first position GetLastFilteredRay Retrieves the last ray in the buffer passing a ray selection filter criteria GetLastRay Ray backward iteration first position InitGetNextRay Initializes index for GetNextRay (Alternative to GetFirstRay) InitGetPreviousRay Initializes index for GetPreviousRay (Alternative to GetLastRay)
Ray Status IsInvalidCoherentRay Returns a boolean indicating whether a specific ray is valid or invalid for the purposes of coherent calculations
Read/Write Rays to Ray Buffer ReadBasicRayDataFromFile Reads FCR-formatted ray files to ray buffer ReadRaysFromFRBSFileToRayBuffer Reads coherent/polarized rays from FRBS file WriteBasicRayDataToFCRFile Writes rays to FCR file format WriteBasicRayDataToFCRFileEx Writes rays to FCR file format with options for including ray wavelengths and applying analysis entity ray filters WriteRaysFromRayBufferToFRBSFile Writes coherent/polarized rays to FRBS file
ApplyFilterToRayPaths Applies a ray selection filter to the raytrace paths database, allowing identification of paths meeting the filter requirements FindPathsContributingToArea Returns contributing raytrace path information for rays within a specified area of an analysis surface FindPathsContributingToPolarAngularRegion Returns contributing raytrace path information for rays within a specified direction region of a directional analysis entity IsUserDefinedRayPathMode Returns True if access user-defined paths, return False if raytrace paths PathAdd Adds a user-defined path PathAddEvent Adds a user-defined path event PathCount Gets number of paths PathDeleteAll Deletes all paths PathDescription Gets path description PathEvent Gets all information corresponding to the path event PathEvent2 Gets all information corresponding to the path event with additional information about diffraction events PathEventDiffractOrder Returns the diffraction order PathEventIsDiffract Returns True if event was a diffracted order from a grating PathEventIsNonsequential Returns True if event is non-sequential PathFilteredPaths Populates an array of ray path numbers for paths with either zero, or nonzero, Filtered Ray Count values PathFilteredPower Returns the Filtered Power value from the specified path number PathFilteredRayCount Returns the Filtered Ray Count value from the specified path number PathFind Returns index of path with the given name ReadRaytraceRayPathsFromFile Reads raytrace ray path data from a binary file into the raytrace paths list SaveRaytraceRayPathsToFile Saves the current raytrace paths to a binary file SetUserDefinedRayPathMode Sets True for user-defined path access, False (default) for raytrace paths StrayLightReport Prints the stray light report for all paths ending on the specified entity node to either the FRED output window or a comma delimited text file StrayLightReportByEntity Prints a compressed form of the stray light report by grouping raytrace paths according to their sequence of splitting events
Custom Elements AddCustomElement Adds a new custom element to the FRED document
Custom Prisms
Edges and Holes (for Lenses and Mirrors only)
Generic ConvertToCustomElement Converts an element from predefined to custom
Lenses AddLens Adds lens element to the FRED doc
Subassemblies
Mirrors GetMirrorConic Gest the Mirror Element conic constant SetMirrorConic Sets the Mirror Element conic constant
Vendor Catalogs AddCatalogLens Adds catalog lens AddCatalogLensReversed Adds catalog lens with the ordering of the surfaces reversed from their catalog definition
Asphere
Auxiliary Data AuxDataFindNameOnSurf Finds the given name on a specified surface AuxDataGetCount Returns the number of auxiliary data items defined for a surface AuxDataRemoveAll Removes all entries from a specific Aux Tab AuxDataSetData Sets aux data value
Bicubic Mesh (sampled) GetSampledSurfValue Gets specific z-values of a Sampled Surface GetSampledSurfXcoordinate Gets the x-coordinate for a specified row and column SetSampledSurfValue Sets specific z-values of a Sampled Surface SetSampledSurfXcoordinate Sets the x-coordinate for a specified row and column SetSampledSurfYcoordinate Sets the y-coordinate for a specified row and column
Coil GetCoil Retrieves the parameters for a Coil surface type SetCoil Sets the parameters of a Coil surface type
Conic
Conic Foci
Faceted Surface FacetedSurfCreateFromFile Adds a new Faceted Surface from a file on disk (*.obj or *.stl) FacetedSurfExportToObjFile Exports a Faceted Surface from the FRED model to an *.obj file on disk FacetedSurfGetFacetCount Retrieves the number of facets defined in a Faceted Surface FacetedSurfGetUseVertexNormals Retrieves the flag that specifies whether a Faceted Surface is using vertex normal data FacetedSurfHasVertexNormals Retrieves the flag that indicates the presence of vertex normal data for a Faceted Surface FacetedSurfSetFromFile Sets the faceted surface data for an existing faceted surface node using data in a file FacetedSurfSetUseVertexNormals Sets the flag that indicates whether a Faceted Surface should use vertex normal dataGeneric
Generic ChangeSurfRayColor Changes the integer RGB values for a color assigned to a specific ray color option ChangeSurfRayColorOff Turns off the specified ray color option ExplicitSurfEval Evaluates xyz point and surface normal for given surface and uv parameters ExplicitSurfEvalUV Evaluates xyz point and surface normal vectors in UV space for given surface and uv parameters GetChangeSurfRayColor Retrieves the integer RGB values for a color assigned to a specific ray color option GetSurfRayPathNode Retrieves the node ID that a surface is reporting for ray path purposes IsChangeSurfRayColor Determines the active state of a specific ray color setting Sag Computes the sag of a specified Surface entity at given local X,Y coordinates SetSurfRayPathNode Sets the ray path node ID that a surface will report for ray path purposes for an individual surface SetSurfRayPathNodes Sets the ray path node ID that a surface will report for ray path purposes for an array of surfaces SetSurfsAssignCoating Assigns a coating to all surfaces of an input array or to all descended surfaces of an input array SetSurfsAssignMaterials Assigns two materials to all surfaces of an input array or to all descended surfaces of an input array SetSurfsAssignRaytraceCtrl Assigns a raytrace control to all surfaces of an input array or to all descended surfaces of an input array SetSurfsAssignScatter Assigns a scatter model to all surfaces of an input array or to all descended surfaces of an input array SetSurfsAssignSurfRough Assigns a surface roughener to all surfaces of an input array or to all descended surfaces of an input array SetSurfsRemoveScatter Removes a scatter model from all surfaces of an input array or from all descended surfaces of an input array
Get / Set Materials, Coating, Raytrace Control, and Scatter GetSurfCoating Returns the array index of the surface's coating GetSurfIthScatterActive Returns active flag of surf's I'th scatter model SetAllCoatingProp Sets coating on all surfs descended from the given entity
Gluing
Implicit Script Surface
Lens Module Surface ModulePerfLensAfocalGet Retrieves the properties of an afocal lens module surface ModulePerfLensAfocalSet Sets the properties of an afocal lens module surface ModulePerfLensFiniteAdd Adds a finite conjugate lens module surface to the document ModulePerfLensFiniteGet Retrieves the properties of a finite conjugate lens module surface ModulePerfLensFiniteSet Sets the properties of a finite conjugate lens module surface ModulePerfLensInfiniteAdd Adds an infinite conjugate lens module surface to the document ModulePerfLensInfiniteGet Retrieves the properties of an infinite conjugate lens module surface ModulePerfLensInfiniteSet Sets the properties of an infinite conjugate lens module surface ModulePerfSurfInfiniteAdd Adds a new surface module surface type to the document ModulePerfSurfInfiniteGet Retrieves the properties of a surface module surface type ModulePerfSurfInfiniteSet Sets the properties of a surface module surface type ModuleSphereSurfAdd Adds a spherical surface lens module to the document ModuleSphereSurfGet Retrieves the properties of a spherical surface lens module ModuleSphereSurfSet Sets the properties of a spherical surface lens module
Modifiers - Retro-Reflection GetRetroReflect Gets the retro-reflect attributes of a surface SetRetroReflect Sets the retro-reflect attributes of a surface
Modifiers - Surface Deformation GetSurfDeform Gets the attributes of a deformed surface GetSurfDeformFlag Sets enable/disable flag for surface deformation GetSurfDeformSurf Gets the node number of a deforming surface GetSurfDeformScale Gets the scale factor imposed on a deforming surface GetSurfDeformInBaseCoordSysFlag Gets the Base Coordinate System setting on a deformed surface SetSurfDeform Sets the attributes of a deformed surface SetSurfDeformFlag Sets enable/disable flag for surface deformation
Modifiers - Surface Roughness ApplySurfRoughToSurface Applies a surface roughness node to a surface RetrieveSurfRoughFromSurface Retrieves the node number of the surface roughness model assigned to a surface
NURB Surface GetNURBSurfControlPt Gets a control point from a NURB surface using linear indexing (as seen in the GUI dialog) GetNURBSurfControlPtCount Gets the number of control points from a NURB surface GetNURBSurfControlPt2 Gets a control point from a NURB surface using u,v indexing (as seen in the GUI dialog) GetNURBSurfControlPtCount2 Gets the number of control points from a NURB surface along the u,v axes of the control point array GetNURBSurfParameterLimits Gets the min/max parameter values SetNURBSurfControlPt Sets a control point for a NURB surface using linear indexing (as seen in the GUI dialog) SetNURBSurfControlPt2 Sets a control point for a NURB surface using u,v indexing (as seen in the GUI dialog)
Patch Box Settings (explicit surfaces only) GetPatchBoxGranularityU Gets an explicit surface's patch box sampling granularity in the U direction
Plane
Polynomial Asphere
Polynomial Surface
QBfs Polynomial Surface AddQBfsSurf Adds a QBfs type Forbes polynomial surface to the document GetQBfsSurf Retrieves the parameters from a QBfs type Forbes polynomial surface GetQbfsSurfForm Retrieves the surface form specification from a Qbfs type Forbes polynomial surface GetQBfsSurfIthCoef Retrieves the coefficient value of the i'th aspheric term SetQBfsSurf Sets the parameters for a QBfs type Forbes polynomial surface SetQbfsSurfForm Sets the surface form specification for a Qbfs type Forbes polynomial surface SetQBfsSurfIthCoef Sets the i'th aspheric term coefficient value
QCon Polynomial Surface AddQConSurf Adds a QCon type Forbes polynomial surface to the document GetQConSurf Retrieves the parameters from a QCon type Forbes polynomial surface GetQConSurfIthCoef Retrieves the coefficient value of the i'th aspheric term SetQConSurf Sets the parameters for a QCon type Forbes polynomial surface SetQConSurfIthCoef Sets the i'th aspheric term coefficient value
Revolve Surface
Ruled Surface
Remove / Toggle Materials, Coating, Raytrace Control, and Scatter ToggleAllScatterActive Toggles all scatter active flags on all surfs descended from the given entity
Spline Surface
Super-Gaussians Superposition Surface SGSurfAdd Adds a Super-gaussians superposition surface SGSFindTermIndexFromName Retrieves the index value for an SGS surface term provided a string name SGSurfGetTermCount Retrieves the number of terms in an SGS surface's term list SGSurfGetIthTermData Retrieves the parameter values for the I'th term of an SGS surface SGSurfGetIthTermName Retrieves the parameter name for the I'th term of an SGS surface SGSurfSetTermCount Sets the maximum term count SGSurfSetIthTermData Sets the parameters for the I'th term in the term list SGSurfSetIthTermName Sets the name parameter for the I'th term in the term list
Tabulated Cylinder
Toroidal Asphere InitToroidalAsphere Initializes a T_TOROIDALASPHERE structure with default values
Trimmed Parametric ChangeTrimmedParametricCompactState Sets the view state for a trimmed parametric surface (compact or expanded)
Trimming GetDotProdSurfTrim Retrieves the advanced dot-product surface trimming specification from a surface node (Faceted Surface excluded) GetTrimmingSpec Gets trimming specification GetTrimVolMinMax Shorthand to get trimming volume SetDotProdSurfTrim Sets the advanced dot-product surface trimming specification for a surface node (Faceted Surface excluded) SetTrimVolMinMax Shorthand to set trimming volume SetTrimVolume Sets a surface's trimming volume attributes
Tube
Visualization SetAxesDrawable Sets an entity's coordinate axes draw flag SetColorSchemeByIndex Sets color scheme for given entity by index SetColorSchemeByName Sets color scheme for given entity by name SetLimitsDrawable Sets an entity's global trimming volume draw flag SetSurfVisualize Sets the visualization attributes of a surface
XYToroidal Asphere SetXYToroidalAsphereType Sets the toroid type as X or Y
Zernike Surface GetZernikeSurfIthAsphCoef Gets the I'th aspheric coefficient for a Zernike surface GetZernikeSurfOffaxisAngle Gets the off-axis angle applied to a Zernike surface GetZernikeSurfXoffset Gets the X offset (decenter) applied to a Zernike surface GetZernikeSurfYoffset Gets the Y offset (decenter) applied to a Zernike surface SetZernikeSurf Sets the attributes of a Zernike polynomial surface SetZernikeSurfOffaxisAngle Sets the off-axis angle of the Zernike surface SetZernikeSurfOffsets Sets the X and Y offsets (decenters) for a Zernike surface
Aperture Collection Curve GetApertureCurveAlgorithm Gets the algorithm being used for the logical interpretation of the aperture curve members SetApertureCurveAlgorithm Sets the algorithm for the logical interpretation of the aperture curve members Circular Arc
Composite Curve Conic Arc
General GetCurveBasicInfo Gets the basic information about a curve
Line Segment
NURB Curve GetNURBCurveControlPt Retrieves the x,y,z position and weight for a specific control point in a NURB curve GetNURBCurveControlPtCount Retrieves the number of control points in a NURB curve definition GetNURBCurvParameterLimits Gets the NURB curve's parameter limits SetNURBCurve Sets a Non-Uniform Rational B-spline curve in the system SetNURBCurveControlPt Sets the x,y,z position and weight for a specific control point in a NURB curve
Racetrack Curve AddRacetrackCurve Adds a Racetrack curve to the system Segmented Curve
Spline Curve
Acceptance Filters DeleteSrcNthAcceptanceRegion Deletes the N’th Acceptance Filter region from a source node GetSrcAcceptanceRegionCount Queries a source node for the number of Acceptance Filter regions defined GetSrcNthAcceptanceRegion Retrieves the parameters of the N’th Acceptance Filter region from a designated source and stores them in a T_ACCEPTANCE_FILTER data structure InitAcceptanceFilter Initializes the members of a T_ACCEPTANCE_FILTER data structure to default values IsAcceptanceFilterActiveFunction Queries a source node and returns the state of its Acceptance Filter flag SetAcceptanceFilterActiveFlag Sets the Active flag state for the Acceptance Filter settings of a designated source node SetSrcNthAcceptanceRegion Updates the parameters of an existing Acceptance Filter region of a source
Apodization Function Information GetSourceDirApodFuncType Direction apodization function name GetSourceDirFuncType Direction function name
Coherence GetSourceCoherentGridScale Gets the relative scale factors on the size of the internal irradiance grid used for determining coherent source flux GetSourceCoherentPowerSampling Gets the number of divisions in power sampling grid SetSourceCoherentGridScale Sets the relative scale factors on the size of the internal irradiance grid used for determining coherent source flux SetSourceCoherentPowerSampling Sets the number of divisions in power sampling grid
Directional power apodization functions GetSourceDirApodGaussian Gets the exponent and semi-angles IsSourceDirApodGaussian Returns True if source direction apodization function is Gaussian SetSourceDirApodGaussian Sets the exponent and semi-angles for Directional Apodization Inverse Lambertian GetSourceDirApodIsotropic Gets source isotropic direction apodization information IsSourceDirApodIsotropic Returns True if source direction apodization function is Isotropic Lambertian GetSourceDirApodLambertian Gets source Lambertian direction apodization IsSourceDirApodLambertian Returns True if source direction apodization function is Lambertian Sampled as a Function of Spherical Angles GetSourceDirApodSampled Gets source sampled direction apodization
Cos^n or Sin^n in a Given Direction GetSourceDirApodSinCos Gets source sin/cos direction apodization IsSourceDirApodSinCos Returns True if source direction apodization function is sin/cos raised to a power SetSourceDirApodSinCos Sets source direction apodization to sin/cos Super Gaussian GetSourceDirApodSuperGaussian Gets a source's Super Gaussian direction apodization specification IsSourceDirApodSuperGaussian Returns True if a source's direction apodization function is Super Gaussian SetSourceDirApodSuperGaussian Sets a source's Super Gaussian direction apodization specification
Uniform IsSourceDirApodUniform Returns True if source direction apodization function is uniform SetSourceDirApodUniform Sets source direction apodization to uniform
Ray Direction Functions GetSourceDirection Gets ray direction from a source with a single direction plane wave specification IsSourceDirection Determines if source has the "Single direction (plane wave)" ray direction type SetSourceDirection Set ray direction for a source with a single direction plane wave specification
Random Directions Into an Angular Range GetSourceDirRange Retrieves the ray direction data from a source with a "Ray directions into an angular range" type IsSourceDirRange Determines if a source has the "Random directions into an angular range" ray direction type SetSourceDirRange Sets the ray direction data for a source with the "Ray directions into an angular range" type
Random Directions Into a Sphere GetSourceDirSphere Retrieves the number of random directions from a source with a "Random directions into sphere" specification IsSourceDirSphere Determines if a source has the "Random directions into a sphere" ray direction type SetSourceDirSphere Sets the number of random directions for a source with the "Random directions into sphere" specification
Focus to/from a Point GetSourceDirFocus Retrieves ray direction data from a source with a Focus to/from a point specification IsSourceDirFocus Determines if a source has "Focus to/from a point" ray direction type SetSourceDirFocus Sets ray direction data for a source with a Focus to/from a point specification Directions to Rectilinear Grid Points GetSourceDirPositionGrid Retrieves the ray direction data from a source with a rectilinear grid point ray direction type IsSourceDirPositionGrid Determines if the source has "Directions to rectilinear grid points" ray direction type
Directions to Hexagonal Grid Points in Angle Space GetSourceDirGridHex Retrieves ray direction data from a source with a hexagonal grid points in angle space specification IsSourceDirGridHex Determines if a source has the "Directions to hexagonal grid points in angle space" ray direction type SetSourceDirGridHex Sets ray direction data for a source with a hexagonal grid points in angle space specification
Focus to/from two astigmatic focii GetSourceDirAstigmaticFocii Retrieves the ray direction specification from a source with the focus to/from astigmatic focii specification IsSourceDirAstigmaticFocii Queries a source node to determine whether its ray direction specification is the focus to/from astigmatic focii type SetSourceDirAstigmaticFocii Sets the ray direction specification for a source with the focus to/from astigmatic focii specification
Astigmatic Gaussian Beam GetSourceDirAstigmaticGausBeam Retrieves astigmatic Gaussian beam data from a source InitSourceDirAstigmaticGausBeam Initializes a T_SOURCEDIRASTIGGAUSBEAM structure with default values IsSourceDirAstigmaticGausBeam Determines if a specified source direction is an astigmatic Gaussian beam SetSourceDirAstigmaticGausBeam Sets the astigmatic Gaussian beam data for a source
Multiple Source Angles (plane waves) AddSourceDirIthMultiAngle Adds an angle specification for a source with the "Multiple source angles (plane waves)" DeleteSourceDirIthMultiAngle Deletes the i'th angle from a multi-angle directional source GetSourceDirIthMultiAngle Retrieves i'th angle from a multi-angle source GetSourceDirIthMultiAngleActive Retrieves i'th angle activity state from a multi-angle source GetSourceDirMultiAngleCount Retrieves the number of angles in a multi-angle source InsertSourceDirIthMultiAngle Inserts an angle specification for a source with the "Multiple source angles (plane waves)" IsSourceDirMultiAngle Determines if the source direction function is multi-angle plane waves SetSourceDirIthMultiAngleActive Sets the i'th angle activity state for a multi-angle source
Multiple Source Positions AddSourceDirIthMultiPos Adds a position to a multi-position source DeleteSourceDirIthMultiPos Deletes the i'th position specification from a multiple-position directional source GetSourceDirIthMultiPos Retrieves i'th position for a multi-position source GetSourceDirIthMultiPosActive Retrieves the i'th position activity state from a multi-position source GetSourceDirMultiPosCount Retrieves the number of positions in a multi-position source InsertSourceDirIthMultiPos Inserts a position specification for a source with the ray direction type, "Multiple source positions" IsSourceDirMultiPos Determines if the source direction function is multi-positional SetSourceDirIthMultiPosActive Sets the i'th position activity state for a multi-position source SetSourceDirMultiPos Declares the source direction function to be multi-positional Randomly According to Intensity Distribution GetSourceDirSampledPolar Retrieves attributes of the source's "Random according to intensity distribution" ray direction type IsSourceDirSampledPolar Determines if a source has the "Random according to intensity distribution" ray direction type SetSourceDirSampledPolarImportFile Sets the source ray direction to "Randomly according to intensity distribution", specifies the polar and azimuthal axis reference vectors, and populates the intensity table with data from a file SetSourceDirSampledPolarImportFGDFile Sets the source ray direction to "Randomly according to intensity distribution", specifies the polar and azimuthal axis reference vectors, and populates the intensity table with data from a FGD file
Laser Diode Beam GetSourceDirLaserDiode Retrieves the ray direction data from a source with the "Laser Diode Beam" ray direction type InitSourceDirLaserDiode Initializes a T_SOURCEDIRLASERDIODE structure with default values IsSourceDirLaserDiode Determines if a source has the "Laser Diode Beam" ray direction type SetSourceDirLaserDiode Sets the ray direction data for a source with ray direction type type "Laser Diode Beam"
M-Squared Laser Beam GetSourceDirM2Laser Retrieves the ray direction specification from a source with the "M Squared Laser Beam" ray direction type InitSourceDirM2Laser Initializes a T_SOURCEDIRM2LASER structure with default values IsSourceDirM2Laser Determines if a source has the "M Squared Laser Beam" ray direction type
Miscellaneous ReadRayFile Reads ray text file into source of type ray-file
Polarization
Position Power Apodization Functions IsSourcePosApodUniform Returns True if source position apodization function is Uniform (i.e. no apodization)
Gaussian Apodization GetSourcePosApodGaussian Gets source Gaussian position apodization GetSourcePosApodGaussianExponent Gets the Gaussian exponent for Position Apodization SetSourcePosApodGaussianMode Sets higher order TEMnm Gaussian mode information R^n Distance Apodization From a Given Point GetSourcePosApodLength Gets source position apodization length data IsSourcePosApodLength Returns True if source position apodization function is length raised to a power Amplitude/Phase Mask on Rectilinear Grid GetSourcePosApodSamp Gets source position apodization sampled parameter data GetSourcePosApodSampTopVal Gets a specific cell top value given by (row, col) InitSourcePosApodSamp Initializes T_SOURCEPOSAPODSAMPLED structure with default values SetSourcePosApodSamp Sets source position apodization to sampled
Super Gaussian Apodization GetSourcePosApodSuperGaussian Retrieves the width and offset values from a source with the Super Gaussian position apodization GetSourcePosApodSuperGaussianExponent Retrieves the exponent values from a source with the Super Gaussian position apodization GetSourcePosApodSuperGaussianMode Retrieves the mode type from a source with the Super Gaussian position apodization SetSourcePosApodSuperGaussianExponent Sets the exponent values for a source with the Super Gaussian position apodization SetSourcePosApodSuperGaussianMode Sets the mode type for a source with the Super Gaussian position apodization
Ray Position Functions Grid Plane (rectilinear array of points arranged on a plane) GetSourcePosGrid Gets source grid plane position specification Random Plane (random points arranged on a plane) GetSourcePosGridRandom Gets source random grid position specification GetSourcePosGridRandomHoleSemiWidth Gets source random grid position X and Y hole semi-widths SetSourcePosGridRandomHoleSemiWidth Sets random grid position function hole X and Y semi-widths Random Volume (random points arranged in a volume) GetSourcePosVolumeRandom Gets source random volume position specification
Random String (random points arranged in a character or string) GetSourcePosCharacters Gets source characters position specification Random Surface (random points on a designated surface) GetSourcePosSurface Gets source surface position specification Read Rays from a File and Generate Dynamically GetSourcePosImported Gets the filename and parameters of an Imported Rayfile source GetSourcePosImportedFileIsValid Checks validity of imported rayfile GetSourcePosImportedUseWavelengthsFromFile Retrieves the wavelength generation flag from an imported rayfile source IsSourcePosImported Returns True if source position function is Imported Rayfile SetSourcePosImported Sets filename and parameters of Imported Rayfile source SetSourcePosImportedUseWavelengthsFromFile Sets the wavelength generation method flag for an imported rayfile source
Hexagonal Plane (hexagonal array of points arranged on a plane) GetSourcePosGridHex Gets source hex grid position specification IsSourcePosGridHex Returns True if source position function is grid hex Bitmap (points specified by bitmap pixels) GetSourcePosBitmap Gets source bitmap position specification IsSourcePosBitmap Returns True if source position function is bitmap User-defined Rays (manually defined) AddSourceUserRay Appends one user ray GetSourceIthUserRay Gets the i'th user ray SetSourcePosUser Sets source's position function to general Pre-propagation Specifications GetSourceMaterial Gets source immersion material
Visualization
Wavelengths GetSourceIthWavelengthSpec Gets i'th wavelength spec GetSourceWavelengthCount Returns number of wavelengths GetSourceRayWavelengthMethod Gets the method of ray wavelength generation for the source GetSourceRayWavelengthRange Gets the range of wavelengths being generated when using "Random according to spectrum" GetSourceSpectrum Gets the spectrum being used by the source SetSourceIthWavelengthActive Sets the active flag for a source wavelength SetSourceIthWavelengthSpec Sets i'th wavelength spec SetSourcePowerUnits Sets the power units of the source SetSourceRayWavelengthMethod Sets the ray wavelength generation method of the source SetSourceRayWavelengthRange Sets the range of wavelengths when using "Random according to spectrum" SetSourceSpectrum Sets the spectrum being used by the source
Generic Source Primitive Commands AddSourcePrim Adds a Source Primitive node of the requested type to the document SourcePrimConvertToDetailed Converts a Source Primitive node to a Detailed Source node SourcePrimGetDrawColor Retrieves the R,G,B draw color integers from a Source Primitive SourcePrimGetTypeSource Query a source node to retrieve its Source Primitive type SourcePrimGetParmCount Retrieves the number of construction parameters in a Source Primitive node SourcePrimGetParmDescription Retrieves the description string for a specific parameter of a Source Primitive node SourcePrimGetParmValue Retrieves the value of a specific parameter of a Source Primitive SourcePrimGetWavelSingle Retrieves the wavelength value from a Source Primitive using the Single wavelength type SourcePrimGetWavelSpectCount Retrieves the number of options for wavelength specification (Single, List, etc.) supported by a Source Primitive SourcePrimGetWavelSpectType Given an index into the list of supported wavelength specification options, retrieve the corresponding string type (Single, List, etc.) SourcePrimGetWavelSpectValue Retrieves the string form of the wavelength type specification from a Source Primitive node SourcePrimSetDrawColor Sets the draw color for a Source Primitive using R,G,B integers SourcePrimSetParmValue Sets the value of a specific construction parameter of a Source Primitive node SourcePrimSetWavelSingle Sets the wavelength value for a Source Primitive using the Single wavelength option SourcePrimSetWavelSpectValue Sets the wavelength option being used by a Source Primitive node
Point Source (coherent) Commands SourcePrimGetParmPtSrcCohList Retrieves the configuration parameters from a Point Source (coherent) type Source Primitive node that uses the List wavelength option SourcePrimGetParmPtSrcCohSingle Retrieves the configuration parameters from a Point Source (coherent) type Source Primitive node that uses the Single wavelength option SourcePrimSetParmPtSrcCohList Sets the configuration parameters for a Point Source (coherent) type Source Primitive node using the List wavelength option SourcePrimSetParmPtSrcCohSingle Sets the configuration parameters for a Point Source (coherent) type Source Primitive node using the Single wavelength option
Astigmatic Gaussian Beam Commands SourcePrimGetParmAstig Retrieves the configuration parameters from an Astigmatic Gaussian Beam type Source Primitive node SourcePrimSetParmAstig Sets the configuration parameters for an Astigmatic Gaussian Beam type Source Primitive node
Laser Diode Beam (coherent) Commands SourcePrimGetParmLaser Retrieves the configuration parameters from a Laser Diode Beam or M-Squared Laser Beam type Source Primitive node SourcePrimSetParmLaser Sets the configuration parameters for a Laser Diode Beam or M-Squared Laser Beam type Source Primitive node
Ray Fan Commands SourcePrimGetParmRayFan Retrieves the configuration parameters from a Ray Fan type Source Primitive node SourcePrimSetParmRayFan Sets the configuration parameters for a Ray Fan type Source Primitive node
LED (far-field) Commands SourcePrimGetParmLEDff Retrieves the configuration parameters from an LED (far-field) type Source Primitive node SourcePrimSetParmLEDff Sets the configuration parameters for an LED (far-field) type Source Primitive node
CreateRaysFromScalarField Synthesizes a rayset from complex scalar field array data CreateRaysFromScalarFieldFile Synthesizes a rayset from a complex scalar field file CreateRaysFromVectorField Synthesizes a rayset from complex vector field array data CreateRaysFromVectorFieldFile Synthesizes a rayset from a complex vector field file SpatiallyResampleScalarField Spatially resamples a scalar field on a positional grid with a beamlet overlap of 1.0 SpatiallyResampleScalarField2 Spatially resamples a scalar field on a positional grid and allows user specification of beamlet overlap SpatiallyResampleVectorField Spatially resamples vector field components on a positional grid with a beamlet overlap of 1.0 SpatiallyResampleVectorField2 Spatially resamples vector field components on a positional grid and allows user specification of beamlet overlap
Absorption Coefficients DeleteIthMaterialAbsorb Deletes the i'th material absorption data value FindMaterialAbsorbWavel Returns the array index in the material absorption array of the given wavelength MaterialAbsorbCount The count of absorption coefficients
Axial / Radial GRIN RemoveIthAxialRadialGRINMaterial Removes the ith entry in wavelength table of Axial/Radial GRIN material
Catalog Glass
Formula Glass Material AddFormulaGlassMaterial Adds a Formula Glass material GetFormulaGlassFormula Returns code for the Formula Glass formula GetFormulaGlassNumCoeffs Returns the number of Formula Glass coefficients GetFormulaGlassType Returns the Formula Glass type GetFormulaGlassTypeName Returns the given Formula Glass type name GetFormulaGlassIthCoeff Returns the ith Formula Glass coefficient GetFormulaGlassIthCoeffName Returns the ith Formula Glass coefficient name SetFormulaGlassIthCoeff Sets the Formula Glass ith coefficient SetFormulaGlassType Sets the Formula Glass type
Generic DeleteMaterial Deletes material at given array index FindMaterial Returns the array index of the named material RefractiveIndex Returns refractive index at a specified wavelength
Gegenbauer Volume Scatter AddGegenbauerCoefs Appends wavelength and coefficients. Return the coefficient count. GetGegenbauerCoefCount Returns the count of scattering coefficients SetGegenbauerIthCoefs Sets I'th wavelength and scat coefficients SetVolScatGegenbauer Sets the material to use Gegenbauer Scattering
Henyey-Greenstein Volume Scatter AddHenyeyCoef Appends wavelength and G coefficient. Return the coefficient count. GetHenyeyCoefCount Returns the count of scattering coefficients SetVolScatHenyey Sets the material to use Henyey-Greenstein Scattering
GRIN Material Common Settings InitGRINMaterialCommon Initializes a T_GRINCOMMON structure with defaults SetGRINMaterialCommon Sets common parameters for a grin material
Luneberg GRIN RemoveIthLunebergGRINMaterial Removes the ith entry in wavelength table of Luneberg GRIN material
Maxwell GRIN RemoveIthMaxwellGRINMaterial Removes the ith entry in wavelength table of Maxwell GRIN material
Mie Volume Scatter SetVolScatMie Sets the material to use Mie volume scatter SetVolScatMieParticleDensityData Sets the particle diameter distribution function and values GetVolScatMieParticleDensityData Retrieves the particle diameter distribution function and values SetVolScatMieParticleRefIndexData Sets the particle reference wavelength and indices for that wavelength GetVolScatMieParticleRefIndexData Retrieves the particle reference wavelength and indices for that wavelength
Model Material InitModelMaterial Initializes a T_MODELMATERIAL structure with default values
Power-Law GRIN AddPowerLawGRINMaterial Adds a new material node of Power-Law GRIN type AppendPowerLawGRINMaterial Appends a wavelength sample to the N1,N2 table of a power-law GRIN material GetConstantsPowerLawGRINMaterial Retrieves the alpha and g parameters of a power-law GRIN material GetIthPowerLawGRINMaterial Retrieves the wavelength, N1 and N2 parameters from the I'th sample of a power-law GRIN material RemoveIthPowerLawGRINMaterial Removes the I'th sample from the table in a power-law GRIN material SetConstantsPowerLawGRINMaterial Sets the alpha and g parameters of a power-law GRIN material
Sampled Birefringent Material
Sampled Material GetSampledMaterial Gets the attributes of a sample material SetSampledMaterial Sets the attributes of a sample material
Script GRIN SetScriptGRINMaterial Sets script for a script GRIN material
Selfoc GRIN RemoveIthSelfocGRINMaterial Removes the ith entry in wavelength table of Selfoc GRIN material
Spherical GRIN RemoveIthSphericalGRINMaterial Removes the i'th entry in wavelength table of Spherical GRIN material
Volume Scatter Coefficients GetVolScatCoefCount Returns the count of scattering coefficient
Volume Scatter Settings GetVolScatActiveFlag Returns the volume scatter "active" flag SetVolScatActiveFlag Sets the volume scatter "active" flag SetVolScatMaxEvents Sets the max number of scatter events
General Sampled (Rs, Rp, Ts, Tp, angle, wavelength)
Generic EvaluateCoatingMtrlReflP Computes coating P-state complex amplitude reflection coefficient using incident and substrate material IDs EvaluateCoatingMtrlTranS Computes coating S-state complex amplitude transmission coefficient using incident and substrate material IDs EvaluateCoatingTranS Computes coating S-state complex amplitude transmission coefficient using incident and substrate material index values
Jones Matrix GetMatrixCoatingExtra Retrieves the node number of the extra coating applied to the jones matrix coating GetMatrixCoatingPolarizationAlgorithm Retrieves the Jones Matrix coating polarization algorithm for a specified Polarizer / Waveplate (Jones Matrix) coating. SetMatrixCoatingExtra Sets the extra coating specification for a jones matrix coating SetMatrixCoatingPolarizationAlgorithm Sets the Jones Matrix coating polarization algorithm for a specified Polarizer / Waveplate (Jones Matrix) coating.
Quarter Wave Coating
Sampled (R, T, wavelength)
Scripted Coating AddScriptCoating Adds a scripted coating GetScriptCoating Gets text of a scripted coating SetScriptCoating Sets text of a scripted coating
Thin Film ThinFilmCoefficients Computes the real and imaginary amplitude coefficients of a custom thin film stack definition
Encrypted Thin Film AddEncryptedThinFilmCoatingFromData Only intended to support reconstruction of FRED models generated by File > Export > FRED Script Format AddEncryptedThinFilmCoatingFromFile Adds a new Encrypted Thin Film coating model using an *.fec file GetEncryptedThinFilmFileName Retrieves the name of the *.fec file assigned to the coating GetEncryptedThinFilmIsSubstrateAtLastLayer Retrieves the flag indicating the orientation of the substrate relative to the coating stack SetEncryptedThinFilmIsSubstrateAtLastLayer Sets the orientation of the substrate relative to the coating stack
Uncoated
DiffractHOEExRecord Records the OPL polynomials for a grating of the type, "Two source user-recorded holographic optical element"
GetDiffractAddPhasePerLine Returns the phase addition method flag (continuous or modulo 2p) GetDiffractEfficiency Returns the calculated diffraction efficiency value for a single order given initial conditions GetDiffractEfficiencyFile Retrieves the full path name for the primary diffraction efficiency file being used by a surface with grating efficiency type "Full efficiency table" GetDiffractEfficiencyFileSecondary Retrieves the full path name for the secondary diffraction efficiency file being used by a surface with grating efficiency type "Full efficiency table" GetDiffractEfficiencyTable Retrieves the primary diffraction efficiency table values from a surface with diffraction efficiency type "Simple efficiency table" GetDiffractEfficiencyTableSecondary Retrieves the secondary diffraction efficiency table values from a surface with diffraction efficiency type "Simple efficiency table" GetDiffractEfficiencyVolHOE Retrieves the primary diffraction efficiency specification values from a surface with diffraction efficiency type "Volume hologram efficiency" GetDiffractEfficiencyVolHOEAlgorithm Retrieves the primary algorithm mode specification values from a surface with diffraction efficiency type "Volume hologram efficiency" GetDiffractEfficiencyVolHOEAlgorithmSecondary Retrieves the secondary algorithm mode specification values from a surface with diffraction efficiency type "Volume hologram efficiency" GetDiffractEfficiencyVolHOESecondary Retrieves the secondary diffraction efficiency specification values from a surface with diffraction efficiency type "Volume hologram efficiency" GetDiffractEfficiencyVolHOESwellingFactor Retrieves the swelling factor from a grating whose Primary diffraction efficiency type is "Volume hologram efficiency" GetDiffractEfficiencyVolHOESwellingFactorSecondary Retrieves the swelling factor from a grating whose Secondary diffraction efficiency type is "Volume hologram efficiency" GetDiffractType Returns the type of diffraction grating specification applied to a surface GetDiffractHOE Retrieves the grating specification from a surface with the "Two point exposure holographic optical element" grating type GetDiffractHOEEx Retrieves the grating specification from a surface with the "Two point user-recorded holographic optical element" grating type GetDiffractLinear Gets the grating specification from a surface with the Linear type GetDiffractOrderCount Returns number of diffraction orders in the efficiency table GetDiffractPhaseOffsetPerLine Returns the line pair offset for use with the continuous phase addition method GetGratingKVector Retrieves the k-vector and local frequency from a grating for an arbitrary position on the surface GetInterpolatedDiffractEfficiency Retrieve interpolated efficiency values from a grating with the Full diffraction efficiency table specification
IsDiffractingSurface Returns True if the surface being queried has diffraction grating attribute of any type applied
SetDiffractAddPhasePerLine Sets the phase addition method flag (continuous or modulo 2p) SetDiffractEfficiencyFileSecondary Specifies the file to be used for a grating with secondary diffraction efficiency type "Full efficiency table" SetDiffractEfficiencyTable Specifies the data to be used for a grating with primary diffraction efficiency type "Simple efficiency table" SetDiffractEfficiencyTableSecondary Specifies the data to be used for a grating with secondary diffraction efficiency type "Simple efficiency table" SetDiffractEfficiencyVolHOE Sets the primary diffraction efficiency specification values for a surface with diffraction efficiency type "Volume hologram efficiency" SetDiffractEfficiencyVolHOEAlgorithm Sets the algorithm that will be used when computing diffraction efficiency values SetDiffractEfficiencyVolHOEAlgorithmSecondary Sets the algorithm that will be used when computing diffraction efficiency values SetDiffractEfficiencyVolHOESecondary Sets the secondary diffraction efficiency specification values for a surface with diffraction efficiency type "Volume hologram efficiency" SetDiffractEfficiencyVolHOESwellingFactor For a grating whose Primary diffraction efficiency is the "Volume hologram efficiency" type, this command sets the value of the swelling factor SetDiffractEfficiencyVolHOESwellingFactorSecondary For a grating whose Secondary diffraction efficiency is the "Volume hologram efficiency" type, this command sets the value of the swelling factor SetDiffractHOE Sets diffraction grating specification of the type, "Two point exposure holographic optical element" SetDiffractHOEEx Sets the diffraction grating specification of the type, "Two point user-recorded holographic optical element" SetDiffractLinear Sets diffraction grating specification to the Linear type SetDiffractNone Removes any diffraction grating specification on the surface SetDiffractNoPhasePerLine Toggles a grating surface to use the phase option "none" SetDiffractPhaseOffsetPerLine Sets the line pair offset for use with the continuous phase addition method
ABg AddAbgScatter Adds an ABG scatter model
Black Paint AddBlackPaint Adds a generic black paint scatter model Diffuse Binomial AddDiffuseBinomial Adds a Diffuse Binomial scatter model AddDiffuseBinomialFromFile Adds a Diffuse Binomial scatter model from a text file GetTISIntegrationSampling Gets the A and B sampling for TIS integration SetTISIntegrationSampling Sets the A and B sampling for TIS integration Diffuse Polynomial AddDiffusePolynomial Adds a Diffuse Polynomial scatter model AddDiffusePolynomialFromFile Adds a Diffuse Polynomial scatter model from a text file Extended Harvey Shack AddHarveyShackExtendedScatter Adds a new Extended Harvey Shack scatter model to the document GetHarveyShackExtendedScatter Queries an existing Extended Harvey-Shack scatter model for its parameters InitHarveyShackExtendedScatter Initializes a T_HARVEYSHACKEXTENDEDSCATTER data structure SetHarveyShackExtendedScatter Sets the parameters for an existing Extended Harvey-Shack scatter model
Gaussian Diffuse AddGaussianScatter Adds a Gaussian Diffuse scatter model GetGaussianScatter Gets the attributes of a Gaussian Diffuse scatter model Generic AddCatalogScatter Adds a scatter model from one of the scatter catalogs and returns its node number DeleteScatter Deletes scatter model at given array index FindScatter Returns the array index of the named scatter model GetScatter Gets the scatter user-defined type information for the given model ScatterPrepareForEval Prepares scatter model for BSDF function evaluations
Harvey Shack AddHarveyShackScatter Adds a Harvey Shack polished surface scatter model K-Correlation AddKCorrelationScatter Adds a K Correlation surface scatter model Lambertian AddLambertianScatter Adds a Lambertian scatter model Mie (Surface Particulate) AddMieScatter Adds a Mie particle scatter model GetMieScatterCoefficients Returns the S1 & S2 polarization coefficients for a Mie model GetMieScatterPercentAreaCoverage Returns the percent area coverage (PAC) for a Mie particle scatter model GetMieScatterPhaseFunction Returns the Mie phase function InitMieScatter Initializes a T_MIESCATTER structure with default values SetMieScatSurfCoefficients Sets the forward scatter reflection and transmission coefficients of a Mie particle scatter model Phong AddPhongScatter Adds a Phong scatter model GetPhongScatter Gets the attributes of a Phong scatter model Scripted InitScriptScatter Initializes a T_SCRIPTSCATTER structure with default values GetScriptScatter Gets a scripted scatter model AddTabulatedPSDScatter Adds tabulated PSD scatter
Generic SurfRoughCopy Makes a copy of an existing surface roughness node SurfRoughDelete Deletes a surface roughness node from the tree SurfRoughDeleteAllNodes Deletes all surface roughness nodes from the tree SurfRoughFindName Returns the node number of a roughness model provided the string name SurfRoughGetDescription Returns the string description for a surface roughness node SurfRoughGetMaxNodeNum Return the maximum node number currently occupied by a roughness model SurfRoughGetName Returns the string name of a surface roughness node SurfRoughGetNodeCount Returns the number of surface roughness nodes SurfRoughGetType Returns the string type identifier of a surface roughness node SurfRoughIsActive Returns the active state for a surface roughness node SurfRoughIsValidNode Returns a boolean indicating that a node number is a valid roughness model SurfRoughSetActive Sets the active state for a surface roughness node SurfRoughSetDescription Sets the string description for a surface roughness node SurfRoughSetName Sets the string name for a surface roughness node
Sampled Random Surface Normal SurfRoughSRSNCreate Creates a new SRSN roughness node SurfRoughSRSNGetEntries Returns the sampled entries SurfRoughSRSNGetEntryCount Returns the number of sampled entries SurfRoughSRSNGetIthAngle Returns the angle value in degrees for the I'th sample SurfRoughSRSNGetIthProbability Returns the probability value for the I'th sample SurfRoughSRSNGetOverallRoughnessProbability Returns the overall roughness model probability SurfRoughSRSNSetEntries Sets all sampled entries SurfRoughSRSNSetOverallRoughnessProbability Sets the overall roughness model probability
Closed Curve ImpSampAddCurve Adds the curve importance sample to a surface ImpSampGetCurve Gets the attributes of the given importance sample
Ellipsoidal Volume
General ImpSampDelete Deletes i'th importance sample on surface n ImpSampGetName Gets name of i'th importance sample ImpSampGetScatterLevel Retrieves the scatter ancestry level requirement from an importance sample ImpSampSetName Sets name of i'th importance sample ImpSampSetScatterLevel Sets the scatter ancestry level requirement for an importance sample
Given Direction ImpSampAddDir Adds the direction importance sample to a surface
Specular Direction ImpSampAddSpecular Adds the specular direction importance sample to a surface ImpSampGetSpecular Gets the attributes of the given specular direction importance sample
Towards Entity ImpSampAddEntity Adds the node as an importance sample to a surface ImpSampSetEntity Sets the attributes of the given entity importance sample
Towards Point
KeywordAdd Adds a new keyword with a given name and description KeywordApplyToItem Assigns a single keyword to a single entity KeywordCount Retrieves the number of keywords in the document KeywordDelete Deletes a specified keyword and returns the count of the remaining kewyords KeywordFind Returns the node number of an existing keyword given a name as input KeywordGetCountFromItem Returns the number of keywords assigned to a designated item KeywordGetDescription Returns the description string of a keyword KeywordGetName Returns the name of a given keyword node KeywordIsAppliedToItem Returns a boolean indicating whether a specific keyword is assigned to a specific item KeywordRemoveFromItem Removes a specific keyword from a specific item KeywordSetDescription Sets the description string for a specific keyword node KeywordSetName Sets the name string for a specific keyword node KeywordsApplyToItems Applies one or more keywords to one or more items KeywordsGetAllFromItem Retrieves an array of keyword nodes that are assigned to a specific item KeywordsGetAppliedItems Retrieves an array of item node numbers having one or more keyword assignments from those matching an input keywords array KeywordsRemoveFromItems Removes from an array of items any keyword assignments matching an array of input keywords
AddRaytraceCtrl Adds a new raytrace control DeleteRaytraceCtrl Deletes raytrace property at given array index FindRaytraceCtrl Returns the index of the raytrace control with the given name GetRaytraceCtrl Gets the attributes of a raytrace control GetRaytraceCtrlType Returns the raytrace control type InitRaytraceCtrl Initializes a T_RAYTRACECTRL structure with default values
SpectrumCombine Linearly combines two spectrum SpectrumComputeArea Computes the area under a given spectrum SpectrumComputeChromaticity Computes the X,Y chromaticity coordinates of a spectrum SpectrumComputeLuminousEfficacy Compute the Luminous Efficacy of a given spectrum SpectrumCopy Makes a copy of a spectrum SpectrumCreateBlackbody Creates a Blackbody spectrum SpectrumCreateGaussian Creates a Gaussian spectrum SpectrumCreatePredefinedSampled Creates a sampled spectrum of a pre-defined type SpectrumCreateSampled Creates a sampled spectrum SpectrumDelete Deletes a sampled spectrum SpectrumDeleteAllNodes Deletes all spectrum from the document SpectrumFindName Finds the node number of a spectrum by name SpectrumGetBlackbodyNormalizationFlag Gets the normalization flag of a spectrum SpectrumGetBlackbodyTemperature Gets the temperature defining a Blackbody spectrum SpectrumGetDescription Gets the description of a spectrum SpectrumGetGaussianCenterWavelength Gets the center wavelength of a Gaussian function SpectrumGetGaussianHWHM Gets the HWHM of a Gaussian spectrum SpectrumGetMaxNodeNum Gets the maximum node number of all spectrum in the document SpectrumGetName Gets the name of a spectrum from its node number SpectrumGetNodeCount Gets the number of spectrum nodes in the document SpectrumGetRandomWavelength Gets a random wavelength from a spectrum according to its distribution SpectrumGetRange Gets the wavelength range of a spectrum SpectrumGetSampledEntries Gets the wavelength and values for a given sampled spectrum SpectrumGetSampledEntryCount Gets the number of samples in a sampled spectrum SpectrumGetSampledIthValue Gets the value of the I'th sample in a sampled spectrum SpectrumGetSampledIthWavelength Gets the value of the Ith wavelength in a sampled spectrum SpectrumGetValue Gets the value of a spectrum at an arbitrary wavelength SpectrumIsValidNode Checks to see if a node number is a valid spectrum SpectrumSetBlackbodyNormalizationFlag Sets the normalization flag for a Blackbody spectrum SpectrumSetBlackbodyRange Sets the wavelength range for a Blackbody spectrum SpectrumSetBlackbodyTemperature Sets the temperature for a Blackbody spectrum SpectrumSetDescription Sets the description of a spectrum SpectrumSetGaussianCenterWavelength Sets the center wavelength for a Gaussian spectrum SpectrumSetGaussianHWHM Sets the half width at half maximum value for a Gaussian spectrum SpectrumSetGaussianRange Sets the wavelength range for a Gaussian spectrum SpectrumSetName Sets the name of a spectrum SpectrumSetSampledEntries Sets the wavelengths and values for a sampled spectrum
Position/Orientation (Linear Transformations)
AddOperation Adds an operation to a node's linear transformation
Advanced Raytrace
Analyses
Analysis Results Nodes
Analysis Surfaces T_ANALYSIS
Background Grid Best Focus Coatings Configurations
Curves Diffraction Gratings Distributed Computing
Element T_EDGEBEVELS Entity FREDMPC (GPU) Import/Export
Importance Sampling Materials T_MODELMATERIAL
Optimization
Pickups
Polarization
Position / Orientation
Raytrace Control Scatter T_ABGSCATTER T_HARVEYSHACKEXTENDEDSCATTER T_SCATTERSCRIPTEX Sources T_SOURCEDIRM2LASER T_SOURCEPOSAPODSAMPLED Source Primitives T_SOURCEPRIMLASER Surfaces Trimming Volume
Visualization Camera
|