Navigation: Scripting Reference Manual > Functions & Subroutines > ReadRayFile

 

ReadRayFile

 

Contact Us: fredsupport@photonengr.com

 

Description

Reads a ray file into a User-defined source in the associated FRED document.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

numRays = ReadRayFile ( n, fname, from, to, step )

 

Parameters

numRays (Long or Huge_)

The number of rays that were read in, or 0 if there was a problem.

 

n As Long

Node number of the source to add rays.

 

fname As String

Name of the file to read.

 

from As Long (or Huge_)

Ray number in file to begin at.

 

to As Long (or Huge_)

Ray number in file to stop at.

 

step As Long (or Huge_)

Number of rays to skip between rays.

 

Remarks

This function reads a ray file into a User-defined source in the associated FRED document.  If there is a problem, the function sets an error and returns 0 without modifying the source specified by n.

 

The parameter to may be set to a value of -1 to read all rays.

 

This command interprets ray positions in the System units of the FRED document ignoring any units in the file header.

 

See Also

GetRayConsecutiveIntersects

GetRayInitialPower

GetRayPath

GetRaySourceRayNumber

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC