Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Namespace ZOSAPI::Analysis::Settings::EncircledEnergy

Last update: 13.03.2026

Definition:

Classes

Enumeration types

Enumeration type EncircledEnergyTypes

Definition:

enum EncircledEnergyTypes {
  Encircled = 1,
  X_Only = 2,
  Y_Only = 3,
  Ensquared = 4
}

Enumerator Encircled

Enumerator X_Only

Enumerator Y_Only

Enumerator Ensquared

Enumeration type ReferToTypes

Definition:

enum ReferToTypes {
  ChiefRay = 0,
  Centroid = 1,
  Vertex = 2
}

Enumerator ChiefRay

Enumerator Centroid

Enumerator Vertex

Enumeration type ExtendedSourceTypes

Definition:

enum ExtendedSourceTypes {
  Encircled = 1,
  X_Only = 2,
  Y_Only = 3,
  Ensquared = 4,
  X_Distrib = 5,
  Y_Distrib = 6
}

Enumerator Encircled

Enumerator X_Only

Enumerator Y_Only

Enumerator Ensquared

Enumerator X_Distrib

Enumerator Y_Distrib

Enumeration type GeometricLineEdgeSpreadTypes

Definition:

enum GeometricLineEdgeSpreadTypes {
  LineEdge = 1,
  Line = 2,
  Edge = 3
}

Enumerator LineEdge

Enumerator Line

Enumerator Edge

Connect with Ansys