Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Namespace ZOSAPI::Analysis::Settings

Last update: 13.03.2026

Definition:

Child namespaces

Classes

Enumeration types

Enumeration type HuygensPsfTypes

Definition:

enum HuygensPsfTypes {
  Linear,
  Log_Minus_1,
  Log_Minus_2,
  Log_Minus_3,
  Log_Minus_4,
  Log_Minus_5,
  Real,
  Imaginary,
  Phase
}

Enumerator Linear

Enumerator Log_Minus_1

Enumerator Log_Minus_2

Enumerator Log_Minus_3

Enumerator Log_Minus_4

Enumerator Log_Minus_5

Enumerator Real

Enumerator Imaginary

Enumerator Phase

Enumeration type DetectorViewerScaleTypes

Definition:

enum DetectorViewerScaleTypes {
  Linear,
  Log_Minus_5,
  Normalized = Log_Minus_5,
  Log_Minus_10,
  Log_Minus_15
}

Enumerator Linear

Enumerator Log_Minus_5

Enumerator Normalized

Enumerator Log_Minus_10

Enumerator Log_Minus_15

Enumeration type PsfTypes

Definition:

enum PsfTypes {
  X_Linear,
  Y_Linear,
  X_Logarithmic,
  Y_Logarithmic,
  X_Phase,
  Y_Phase,
  X_RealPart,
  Y_RealPart,
  X_ImaginaryPart,
  Y_ImaginaryPart
}

Enumerator X_Linear

Enumerator Y_Linear

Enumerator X_Logarithmic

Enumerator Y_Logarithmic

Enumerator X_Phase

Enumerator Y_Phase

Enumerator X_RealPart

Enumerator Y_RealPart

Enumerator X_ImaginaryPart

Enumerator Y_ImaginaryPart

Enumeration type PsfSpread

Definition:

enum PsfSpread {
  Line,
  Edge
}

Enumerator Line

Enumerator Edge

Enumeration type Rotations

Definition:

enum Rotations {
  Rotate_0,
  Rotate_90,
  Rotate_180,
  Rotate_270
}

Enumerator Rotate_0

Enumerator Rotate_90

Enumerator Rotate_180

Enumerator Rotate_270

Enumeration type Polarizations

Definition:

enum Polarizations {
  None,
  Ex,
  Ey,
  Ez
}

Enumerator None

Enumerator Ex

Enumerator Ey

Enumerator Ez

Enumeration type ScanTypes

Definition:

enum ScanTypes {
  Plus_Y = 0,
  Plus_X = 1,
  Minus_Y = 2,
  Minus_X = 3
}

Enumerator Plus_Y

Enumerator Plus_X

Enumerator Minus_Y

Enumerator Minus_X

Enumeration type AxisType

Definition:

enum AxisType {
  X = 0,
  Y = 1,
  Z = 2
}

Enumerator X

Enumerator Y

Enumerator Z

Enumeration type SourceGia

Definition:

enum SourceGia {
  Uniform = 0,
  Lambertian = 1
}

Enumerator Uniform

Enumerator Lambertian

Enumeration type Parity

Definition:

enum Parity {
  Even = 0,
  Odd = 1
}

Enumerator Even

Enumerator Odd

Enumeration type ReferenceGia

Definition:

enum ReferenceGia {
  ChiefRay = 0,
  Vertex = 1,
  PrimaryChief = 2,
  Centroid = 3
}

Enumerator ChiefRay

Enumerator Vertex

Enumerator PrimaryChief

Enumerator Centroid

Enumeration type DisplayOption

Definition:

enum DisplayOption {
  AllRays,
  FailedRays,
  PassedRays
}

Enumerator AllRays

Enumerator FailedRays

Enumerator PassedRays

Enumeration type STAREffectsOptions

Definition:

enum STAREffectsOptions {
  On = 0,
  Difference = 1
}

Enumerator On

Enumerator Difference

Connect with Ansys