Skip to main content

ZOS-API interface 2024 R1

ZOSAPI.Analysis.Settings Namespace Reference

Last update: 17.07.2025

Namespaces

namespace  Aberrations
 
namespace  Coatings
 
namespace  DiffractionEfficiency
 
namespace  EncircledEnergy
 
namespace  ExtendedScene
 
namespace  Fans
 
namespace  Materials
 
namespace  Mtf
 
namespace  NSCSurface
 
namespace  Psf
 
namespace  RayTracing
 
namespace  RMS
 
namespace  Spot
 
namespace  Surface
 
namespace  Wavefront
 

Classes

interface  IAS_
 Base class for all analysis settings interfaces. This class can be accessed via the IA_ interface. More...
 
interface  IAS_CriticalRayTracer
 Settings to control the Critical Ray Trace analysis. More...
 
interface  IAS_Detector
 
interface  IAS_Field
 
interface  IAS_FileComparator
 Settings to control the Critical Ray Trace analysis. More...
 
interface  IAS_Interferogram
 
interface  IAS_Surface
 
interface  IAS_WavefrontMap
 
interface  IAS_Wavelength
 
interface  IAS_XXXTemplateXXX
 

Enumerations

enum  HuygensPsfTypes {
  Linear , Log_Minus_1 , Log_Minus_2 , Log_Minus_3 ,
  Log_Minus_4 , Log_Minus_5 , Real , Imaginary ,
  Phase
}
 
enum  DetectorViewerScaleTypes {
  Linear , Log_Minus_5 , Normalized = Log_Minus_5 , Log_Minus_10 ,
  Log_Minus_15
}
 
enum  PsfTypes {
  X_Linear , Y_Linear , X_Logarithmic , Y_Logarithmic ,
  X_Phase , Y_Phase , X_RealPart , Y_RealPart ,
  X_ImaginaryPart , Y_ImaginaryPart
}
 
enum  PsfSpread { Line , Edge }
 
enum  Rotations { Rotate_0 , Rotate_90 , Rotate_180 , Rotate_270 }
 
enum  Polarizations { None , Ex , Ey , Ez }
 
enum  ScanTypes { Plus_Y = 0 , Plus_X = 1 , Minus_Y = 2 , Minus_X = 3 }
 
enum  AxisType { X = 0 , Y = 1 , Z = 2 }
 
enum  SourceGia { Uniform = 0 , Lambertian = 1 }
 
enum  Parity { Even = 0 , Odd = 1 }
 
enum  ReferenceGia { ChiefRay = 0 , Vertex = 1 , PrimaryChief = 2 , Centroid = 3 }
 
enum  DisplayOption { AllRays , FailedRays , PassedRays }
 
enum  STAREffectsOptions { On = 0 , Difference = 1 }
 

Enumeration Type Documentation

◆ AxisType

Enumerator
X 
Y 
Z 

◆ DetectorViewerScaleTypes

Enumerator
Linear 
Log_Minus_5 
Normalized 
Log_Minus_10 
Log_Minus_15 

◆ DisplayOption

Enumerator
AllRays 
FailedRays 
PassedRays 

◆ HuygensPsfTypes

Enumerator
Linear 
Log_Minus_1 
Log_Minus_2 
Log_Minus_3 
Log_Minus_4 
Log_Minus_5 
Real 
Imaginary 
Phase 

◆ Parity

Enumerator
Even 
Odd 

◆ Polarizations

Enumerator
None 
Ex 
Ey 
Ez 

◆ PsfSpread

Enumerator
Line 
Edge 

◆ PsfTypes

Enumerator
X_Linear 
Y_Linear 
X_Logarithmic 
Y_Logarithmic 
X_Phase 
Y_Phase 
X_RealPart 
Y_RealPart 
X_ImaginaryPart 
Y_ImaginaryPart 

◆ ReferenceGia

Enumerator
ChiefRay 
Vertex 
PrimaryChief 
Centroid 

◆ Rotations

Enumerator
Rotate_0 
Rotate_90 
Rotate_180 
Rotate_270 

◆ ScanTypes

Enumerator
Plus_Y 
Plus_X 
Minus_Y 
Minus_X 

◆ SourceGia

Enumerator
Uniform 
Lambertian 

◆ STAREffectsOptions

Enumerator
On 
Difference 

Connect with Ansys