Skip to main content

ZOS-API interface 2024 R2

ZOSAPI.Analysis.Data.IAR_RayInfo Interface Reference

Last update: 17.07.2025

Properties

int RayIndex [get]
 Indicates the source ray from which is the original ancestor for this segment.
 
int Segment [get]
 Sequential from 0 to the total number of segments the generated from the origin ray.
 
int Parent [get]
 Indicates which prior segment generated this one.
 
int Level [get]
 Indicates how many segments this ray is away from the source ray.
 
int In_object [get]
 Indicates which object the segment is traveling through.
 
int Hit_object [get]
 Indicates which object the segment struck (if 0, the ray missed all objects and is terminated)
 
int Hit_face [get]
 Indicates which face the segment struck on the object.
 
double X [get]
 Global X-coordinate of ray intercept.
 
double Y [get]
 Global Y-coordinate of ray intercept.
 
double Z [get]
 Global Z-coordinate of ray intercept.
 
double L [get]
 Global X-direction cosine of the ray following the surface.
 
double M [get]
 Global Y-direction cosine of the ray following the surface.
 
double N [get]
 Global Z-direction cosine of the ray following the surface.
 
double Nx [get]
 Global X-component of object normal vector at the ray segment-object intercept point.
 
double Ny [get]
 Global Y-component of object normal vector at the ray segment-object intercept point.
 
double Nz [get]
 Global Z-component of object normal vector at the ray segment-object intercept point.
 
double Ex [get]
 Electric field X-component in global coordinate system.
 
double Ey [get]
 Electric field Y-component in global coordinate system.
 
double Ez [get]
 Electric field Z-component in global coordinate system.
 
double PathLength [get]
 Ray path length from previous surface in lens-units.
 
double OpticalPathLength [get]
 Ray optical path length (path*index of refraction) from previous surface in lens-units.
 
double Wavelength [get]
 Wavelength in microns.
 
int Vignetted [get]
 0 if not vignetted, else vignetted surface number
 
int Error [get]
 0 if no error
 

Property Documentation

◆ Error

int ZOSAPI.Analysis.Data.IAR_RayInfo.Error
get

0 if no error

0 if no error

◆ Ex

double ZOSAPI.Analysis.Data.IAR_RayInfo.Ex
get

Electric field X-component in global coordinate system.

Electric field X-component in global coordinate system

◆ Ey

double ZOSAPI.Analysis.Data.IAR_RayInfo.Ey
get

Electric field Y-component in global coordinate system.

Electric field Y-component in global coordinate system

◆ Ez

double ZOSAPI.Analysis.Data.IAR_RayInfo.Ez
get

Electric field Z-component in global coordinate system.

Electric field Z-component in global coordinate system

◆ Hit_face

int ZOSAPI.Analysis.Data.IAR_RayInfo.Hit_face
get

Indicates which face the segment struck on the object.

Indicates which face the segment struck on the object

◆ Hit_object

int ZOSAPI.Analysis.Data.IAR_RayInfo.Hit_object
get

Indicates which object the segment struck (if 0, the ray missed all objects and is terminated)

Indicates which object the segment struck (if 0, the ray missed all objects and is terminated)

◆ In_object

int ZOSAPI.Analysis.Data.IAR_RayInfo.In_object
get

Indicates which object the segment is traveling through.

Indicates which object the segment is traveling through

◆ L

double ZOSAPI.Analysis.Data.IAR_RayInfo.L
get

Global X-direction cosine of the ray following the surface.

Global X-direction cosine of the ray following the surface

◆ Level

int ZOSAPI.Analysis.Data.IAR_RayInfo.Level
get

Indicates how many segments this ray is away from the source ray.

Indicates how many segments this ray is away from the source ray

◆ M

double ZOSAPI.Analysis.Data.IAR_RayInfo.M
get

Global Y-direction cosine of the ray following the surface.

Global Y-direction cosine of the ray following the surface

◆ N

double ZOSAPI.Analysis.Data.IAR_RayInfo.N
get

Global Z-direction cosine of the ray following the surface.

Global Z-direction cosine of the ray following the surface

◆ Nx

double ZOSAPI.Analysis.Data.IAR_RayInfo.Nx
get

Global X-component of object normal vector at the ray segment-object intercept point.

Global X-component of object normal vector at the ray segment-object intercept point

◆ Ny

double ZOSAPI.Analysis.Data.IAR_RayInfo.Ny
get

Global Y-component of object normal vector at the ray segment-object intercept point.

Global Y-component of object normal vector at the ray segment-object intercept point

◆ Nz

double ZOSAPI.Analysis.Data.IAR_RayInfo.Nz
get

Global Z-component of object normal vector at the ray segment-object intercept point.

Global Z-component of object normal vector at the ray segment-object intercept point

◆ OpticalPathLength

double ZOSAPI.Analysis.Data.IAR_RayInfo.OpticalPathLength
get

Ray optical path length (path*index of refraction) from previous surface in lens-units.

Ray optical path length (path*index of refraction) from previous surface in lens-units

◆ Parent

int ZOSAPI.Analysis.Data.IAR_RayInfo.Parent
get

Indicates which prior segment generated this one.

Indicates which prior segment generated this one

◆ PathLength

double ZOSAPI.Analysis.Data.IAR_RayInfo.PathLength
get

Ray path length from previous surface in lens-units.

Ray path length from previous surface in lens-units

◆ RayIndex

int ZOSAPI.Analysis.Data.IAR_RayInfo.RayIndex
get

Indicates the source ray from which is the original ancestor for this segment.

Indicates the source ray from which is the original ancestor for this segment

◆ Segment

int ZOSAPI.Analysis.Data.IAR_RayInfo.Segment
get

Sequential from 0 to the total number of segments the generated from the origin ray.

Sequential from 0 to the total number of segments the generated from the origin ray

◆ Vignetted

int ZOSAPI.Analysis.Data.IAR_RayInfo.Vignetted
get

0 if not vignetted, else vignetted surface number

0 if not vignetted, else vignetted surface number

◆ Wavelength

double ZOSAPI.Analysis.Data.IAR_RayInfo.Wavelength
get

Wavelength in microns.

Wavelength in microns

◆ X

double ZOSAPI.Analysis.Data.IAR_RayInfo.X
get

Global X-coordinate of ray intercept.

Global X-coordinate of ray intercept

◆ Y

double ZOSAPI.Analysis.Data.IAR_RayInfo.Y
get

Global Y-coordinate of ray intercept.

Global Y-coordinate of ray intercept

◆ Z

double ZOSAPI.Analysis.Data.IAR_RayInfo.Z
get

Global Z-coordinate of ray intercept.

Global Z-coordinate of ray intercept

Connect with Ansys