Namespace ZOSAPI::Analysis
Last update: 13.03.2026
Definition:
Child namespaces
- ZOSAPI::Analysis::Data
- ZOSAPI::Analysis::PhysicalOptics
- ZOSAPI::Analysis::RayTracing
- ZOSAPI::Analysis::Settings
- ZOSAPI::Analysis::Tolerancing
Classes
- ZOSAPI::Analysis::I_Analyses
- ZOSAPI::Analysis::IA_
- ZOSAPI::Analysis::IColorTranslator
- ZOSAPI::Analysis::IMessage
- ZOSAPI::Analysis::IMessages
- ZOSAPI::Analysis::IUser2DLineData
- ZOSAPI::Analysis::IUserAnalysisData
- ZOSAPI::Analysis::IUserGridData
- ZOSAPI::Analysis::IUserGridRGBData
- ZOSAPI::Analysis::IUserTextData
Enumeration types
Enumeration type AnalysisIDM
Definition:
enum AnalysisIDM {
XXXTemplateXXX = -1,
RayFan,
OpticalPathFan,
PupilAberrationFan,
FieldCurvatureAndDistortion,
FocalShiftDiagram,
GridDistortion,
LateralColor,
LongitudinalAberration,
RayTrace,
SeidelCoefficients,
SeidelDiagram,
ZernikeAnnularCoefficients,
ZernikeCoefficientsVsField,
ZernikeFringeCoefficients,
ZernikeStandardCoefficients,
FftMtf,
FftThroughFocusMtf,
GeometricThroughFocusMtf,
GeometricMtf,
FftMtfMap,
GeometricMtfMap,
FftSurfaceMtf,
FftMtfvsField,
GeometricMtfvsField,
HuygensMtfvsField,
HuygensMtf,
HuygensSurfaceMtf,
HuygensThroughFocusMtf,
FftPsf,
FftPsfCrossSection,
FftPsfLineEdgeSpread,
HuygensPsfCrossSection,
HuygensPsf,
DiffractionEncircledEnergy,
GeometricEncircledEnergy,
GeometricLineEdgeSpread,
ExtendedSourceEncircledEnergy,
SurfaceCurvatureCross,
SurfacePhaseCross,
SurfaceSagCross,
SurfaceCurvature,
SurfacePhase,
SurfaceSag,
StandardSpot,
ThroughFocusSpot,
FullFieldSpot,
MatrixSpot,
ConfigurationMatrixSpot,
RMSField,
RMSFieldMap,
RMSLambdaDiagram,
RMSFocus,
Foucault,
Interferogram,
WavefrontMap,
DetectorViewer,
Draw2D,
Draw3D,
ImageSimulation,
GeometricImageAnalysis,
IMABIMFileViewer,
GeometricBitmapImageAnalysis,
BitmapFileViewer,
LightSourceAnalysis,
PartiallyCoherentImageAnalysis,
ExtendedDiffractionImageAnalysis,
BiocularFieldOfViewAnalysis,
BiocularDipvergenceConvergence,
RelativeIllumination,
VignettingDiagramSettings,
FootprintSettings,
YYbarDiagram,
PowerFieldMapSettings,
PowerPupilMapSettings,
IncidentAnglevsImageHeight,
FiberCouplingSettings,
YNIContributions,
SagTable,
CardinalPoints,
DispersionDiagram,
GlassMap,
AthermalGlassMap,
InternalTransmissionvsWavelength,
DispersionvsWavelength,
GrinProfile,
GradiumProfile,
UniversalPlot1D,
UniversalPlot2D,
PolarizationRayTrace,
PolarizationPupilMap,
Transmission,
PhaseAberration,
TransmissionFan,
ParaxialGaussianBeam,
SkewGaussianBeam,
PhysicalOpticsPropagation,
BeamFileViewer,
ReflectionvsAngle,
TransmissionvsAngle,
AbsorptionvsAngle,
DiattenuationvsAngle,
PhasevsAngle,
RetardancevsAngle,
ReflectionvsWavelength,
TransmissionvsWavelength,
AbsorptionvsWavelength,
DiattenuationvsWavelength,
PhasevsWavelength,
RetardancevsWavelength,
DirectivityPlot,
SourcePolarViewer,
PhotoluminscenceViewer,
SourceSpectrumViewer,
RadiantSourceModelViewerSettings,
SurfaceDataSettings,
PrescriptionDataSettings,
FileComparatorSettings,
PartViewer,
ReverseRadianceAnalysis,
PathAnalysis,
FluxvsWavelength,
RoadwayLighting,
SourceIlluminationMap,
ScatterFunctionViewer,
ScatterPolarPlotSettings,
ZemaxElementDrawing,
ShadedModel,
NSCShadedModel,
NSC3DLayout,
NSCObjectViewer,
RayDatabaseViewer,
ISOElementDrawing,
SystemData,
TestPlateList,
SourceColorChart1931,
SourceColorChart1976,
PrescriptionGraphic,
CriticalRayTracer,
ContrastLoss,
CoatingListing,
FullFieldAberration,
SurfaceSlope,
SurfaceSlopeCross,
QuickYield,
SystemCheck,
ToleranceYield,
ToleranceHistogram,
DiffEfficiency2D,
DiffEfficiencyAngular,
DiffEfficiencyChromatic,
NSCSurfaceSag,
NSCSingleRayTrace,
NSCGeometricMtf,
SurfacePhaseSlope,
SurfacePhaseSlopeCross,
STARAlignCheck,
STARSysViewer,
STAR2DDefPlot,
STARPerfChange,
STARIndexVsTemp,
STARInspectFEA,
UserDefinedCOM,
NEST,
NSCSpotStandardNative
}
All available analysis types. See the I_Analyses interface for more information.
Enumerator XXXTemplateXXX
Enumerator RayFan
Ray Fan.
Enumerator OpticalPathFan
OPD Fan.
Enumerator PupilAberrationFan
Pupil Aberration Fan.
Enumerator FieldCurvatureAndDistortion
Field Curv/Dist.
Enumerator FocalShiftDiagram
Focal Shift.
Enumerator GridDistortion
Grid Distortion.
Enumerator LateralColor
Lateral Color.
Enumerator LongitudinalAberration
Longitudinal Aberration.
Enumerator RayTrace
Single Ray Trace.
Enumerator SeidelCoefficients
Seidel Coefficients.
Enumerator SeidelDiagram
Seidel Diagram.
Enumerator ZernikeAnnularCoefficients
Zernike Annular Coefficients.
Enumerator ZernikeCoefficientsVsField
Zernike Coefficients vs. Field.
Enumerator ZernikeFringeCoefficients
Zernike Fringe Coefficients.
Enumerator ZernikeStandardCoefficients
Zernike Standard Coefficients.
Enumerator FftMtf
FFT MTF.
Enumerator FftThroughFocusMtf
FFT Through Focus MTF.
Enumerator GeometricThroughFocusMtf
Through Focus Geometric MTF.
Enumerator GeometricMtf
Geometric MTF.
Enumerator FftMtfMap
FFT MTF Map.
Enumerator GeometricMtfMap
Geometric MTF Map.
Enumerator FftSurfaceMtf
FFT Surface MTF.
Enumerator FftMtfvsField
FFT MTF vs. Field.
Enumerator GeometricMtfvsField
Geometric MTF vs. Field.
Enumerator HuygensMtfvsField
Huygens MTF vs. Field.
Enumerator HuygensMtf
Huygens MTF.
Enumerator HuygensSurfaceMtf
Huygens Surface MTF.
Enumerator HuygensThroughFocusMtf
Huygens Through Focus MTF.
Enumerator FftPsf
FFT PSF.
Enumerator FftPsfCrossSection
FFT PSF Cross Section.
Enumerator FftPsfLineEdgeSpread
FFT Line/Edge Spread.
Enumerator HuygensPsfCrossSection
Huygens PSF Cross Section.
Enumerator HuygensPsf
Huygens PSF.
Enumerator DiffractionEncircledEnergy
Diffraction Encircled Energy.
Enumerator GeometricEncircledEnergy
Geometric Encircled Energy.
Enumerator GeometricLineEdgeSpread
Line/Edge Spread.
Enumerator ExtendedSourceEncircledEnergy
Extended Source Encircled Energy.
Enumerator SurfaceCurvatureCross
Surface Curvature Cross Section.
Enumerator SurfacePhaseCross
Surface Phase Cross Section.
Enumerator SurfaceSagCross
Surface Sag Cross Section.
Enumerator SurfaceCurvature
Surface Curvature.
Enumerator SurfacePhase
Surface Phase.
Enumerator SurfaceSag
Surface Sag.
Enumerator StandardSpot
Spot Diagram.
Enumerator ThroughFocusSpot
Through Focus Spot Diagram.
Enumerator FullFieldSpot
Full Field Spot Diagram.
Enumerator MatrixSpot
Matrix Spot Diagram.
Enumerator ConfigurationMatrixSpot
Configuration Matrix Spot Diagram.
Enumerator RMSField
RMS vs. Field.
Enumerator RMSFieldMap
RMS Field Map.
Enumerator RMSLambdaDiagram
RMS vs. Wavelength.
Enumerator RMSFocus
RMS vs. Focus.
Enumerator Foucault
Foucault Analysis.
Enumerator Interferogram
Interferogram.
Enumerator WavefrontMap
Wavefront Map.
Enumerator DetectorViewer
Detector Viewer.
Enumerator Draw2D
Layout.
Enumerator Draw3D
3D Layout
Enumerator ImageSimulation
Image Simulation.
Enumerator GeometricImageAnalysis
Geometric Image Analysis.
Enumerator IMABIMFileViewer
IMA/BIM File Viewer.
Enumerator GeometricBitmapImageAnalysis
Geometric Bitmap Image Analysis.
Enumerator BitmapFileViewer
Bitmap File Viewer.
Enumerator LightSourceAnalysis
Light Source Analysis.
Enumerator PartiallyCoherentImageAnalysis
Partially Coherent Image Analysis.
Enumerator ExtendedDiffractionImageAnalysis
Extended Diffraction Image Analysis.
Enumerator BiocularFieldOfViewAnalysis
Biocular Field Of View Analysis.
Enumerator BiocularDipvergenceConvergence
Biocular Dipvergence/Convergence.
Enumerator RelativeIllumination
Relative Illumination.
Enumerator VignettingDiagramSettings
Vignetting Diagram.
Enumerator FootprintSettings
Footprint Diagram.
Enumerator YYbarDiagram
Y-Ybar Diagram.
Enumerator PowerFieldMapSettings
Power Field Map.
Enumerator PowerPupilMapSettings
Power Pupil Map.
Enumerator IncidentAnglevsImageHeight
Incident Angle vs. Image Height.
Enumerator FiberCouplingSettings
Fiber Coupling.
Enumerator YNIContributions
YNI Contributions.
Enumerator SagTable
Sag Table.
Enumerator CardinalPoints
Cardinal Point Data.
Enumerator DispersionDiagram
Dispersion Diagram.
Enumerator GlassMap
Glass Map.
Enumerator AthermalGlassMap
Athermal Glass Map.
Enumerator InternalTransmissionvsWavelength
Internal Transmission.
Enumerator DispersionvsWavelength
Dispersion vs. Wavelength.
Enumerator GrinProfile
Grin Profile.
Enumerator GradiumProfile
Gradium Profile.
Enumerator UniversalPlot1D
Universal Plot 1D.
Enumerator UniversalPlot2D
Universal Plot 2D.
Enumerator PolarizationRayTrace
Polarization Ray Trace.
Enumerator PolarizationPupilMap
Polarization Pupil Map.
Enumerator Transmission
Transmission.
Enumerator PhaseAberration
Phase Aberration.
Enumerator TransmissionFan
Transmission Fan.
Enumerator ParaxialGaussianBeam
Paraxial Gaussian Beam Data.
Enumerator SkewGaussianBeam
Skew Gaussian Beam Data.
Enumerator PhysicalOpticsPropagation
Physical Optics Propagation.
Enumerator BeamFileViewer
Beam File Viewer.
Enumerator ReflectionvsAngle
Reflection vs. Angle.
Enumerator TransmissionvsAngle
Transmission vs. Angle.
Enumerator AbsorptionvsAngle
Absorption vs. Angle.
Enumerator DiattenuationvsAngle
Diattenuation vs. Angle.
Enumerator PhasevsAngle
Phase vs. Angle.
Enumerator RetardancevsAngle
Retardance vs. Angle.
Enumerator ReflectionvsWavelength
Reflection vs. Wavelength.
Enumerator TransmissionvsWavelength
Transmission vs. Wavelength.
Enumerator AbsorptionvsWavelength
Absorption vs. Wavelength.
Enumerator DiattenuationvsWavelength
Diattenuation vs. Wavelength.
Enumerator PhasevsWavelength
Phase vs. Wavelength.
Enumerator RetardancevsWavelength
Retardance vs. Wavelength.
Enumerator DirectivityPlot
Source Directivity Viewer.
Enumerator SourcePolarViewer
Source Polar Viewer.
Enumerator PhotoluminscenceViewer
Phosphors and Fluorescence Spectrum Plot.
Enumerator SourceSpectrumViewer
Source Spectrum Viewer.
Enumerator RadiantSourceModelViewerSettings
Radiant Source Model™ Viewer.
Enumerator SurfaceDataSettings
Surface Data.
Enumerator PrescriptionDataSettings
Prescription Data.
Enumerator FileComparatorSettings
File Comparator.
Enumerator PartViewer
Part Viewer.
Enumerator ReverseRadianceAnalysis
ReverseRadiance™ Analysis.
Enumerator PathAnalysis
Path Analysis.
Enumerator FluxvsWavelength
Flux vs. Wavelength.
Enumerator RoadwayLighting
Roadway Lighting Analysis.
Enumerator SourceIlluminationMap
Source Illumination Map.
Enumerator ScatterFunctionViewer
Scatter Function Viewer.
Enumerator ScatterPolarPlotSettings
Scatter Polar Plot.
Enumerator ZemaxElementDrawing
Zemax Element Drawing.
Enumerator ShadedModel
Shaded Model.
Enumerator NSCShadedModel
NSC Shaded Model.
Enumerator NSC3DLayout
NSC 3D Layout.
Enumerator NSCObjectViewer
NSC Object Viewer.
Enumerator RayDatabaseViewer
Ray Database Viewer.
Enumerator ISOElementDrawing
ISO Element Drawing.
Enumerator SystemData
System Data.
Enumerator TestPlateList
Test Plate List.
Enumerator SourceColorChart1931
CIE 1931 Color Chart.
Enumerator SourceColorChart1976
CIE 1976 Color Chart.
Enumerator PrescriptionGraphic
System Summary Graphic.
Enumerator CriticalRayTracer
Critical Ray Tracer.
Enumerator ContrastLoss
Enumerator CoatingListing
Enumerator FullFieldAberration
Enumerator SurfaceSlope
Surface Slope.
Enumerator SurfaceSlopeCross
Surface Slope Cross Section.
Enumerator QuickYield
Quick Yield.
Enumerator SystemCheck
Enumerator ToleranceYield
Tolerancing Yield.
Enumerator ToleranceHistogram
Tolerancing Histogram.
Enumerator DiffEfficiency2D
Diffraction Efficiency 2D.
Enumerator DiffEfficiencyAngular
Diffraction Efficiency Angular.
Enumerator DiffEfficiencyChromatic
Diffraction Efficiency Chromatic.
Enumerator NSCSurfaceSag
NSC Surface Sag.
Enumerator NSCSingleRayTrace
NSC Single Ray Trace.
Enumerator NSCGeometricMtf
Non-Sequential Geometric MTF.
Enumerator SurfacePhaseSlope
Surface Phase Slope.
Enumerator SurfacePhaseSlopeCross
Phase Slope Cross Section.
Enumerator STARAlignCheck
STAR Alignment Check.
Enumerator STARSysViewer
STAR System Viewer.
Enumerator STAR2DDefPlot
STAR 2D Deformation Plot.
Enumerator STARPerfChange
STAR Performance Analysis.
Enumerator STARIndexVsTemp
STAR Thermal Index Plot.
Enumerator STARInspectFEA
STAR Multiphysics Data Viewer.
Enumerator UserDefinedCOM
USER Analysis.
Enumerator NEST
NEST.
Enumerator NSCSpotStandardNative
NSC Spot Diagram.
Enumeration type ColorPaletteType
Definition:
enum ColorPaletteType {
GreyScale,
FalseColor,
FalseColorOriginal,
Viridis,
Magma
}
Enumerator GreyScale
Enumerator FalseColor
Enumerator FalseColorOriginal
Enumerator Viridis
Enumerator Magma
Enumeration type POPSampling
Definition:
enum POPSampling {
S_32 = 5,
S_64 = 6,
S_128 = 7,
S_256 = 8,
S_512 = 9,
S_1024 = 10,
S_2048 = 11,
S_4096 = 12,
S_8192 = 13,
S_16384 = 14,
S_32768 = 15,
S_65536 = 16,
S_131072 = 17,
S_262144 = 18,
S_524288 = 19,
S_1048576 = 20,
S_2097152 = 21,
S_4194304 = 22,
S_8388608 = 23,
S_16777216 = 24,
S_33554432 = 25,
S_67108864 = 26,
S_134217728 = 27,
S_268435456 = 28,
S_536870912 = 29,
S_1073741824 = 30,
S_1K = 10,
S_2K = 11,
S_4K = 12,
S_8K = 13,
S_16K = 14,
S_32K = 15,
S_64K = 16,
S_128K = 17,
S_256K = 18,
S_512K = 19,
S_1M = 20,
S_2M = 21,
S_4M = 22,
S_8M = 23,
S_16M = 24,
S_32M = 25,
S_64M = 26,
S_128M = 27,
S_256M = 28,
S_512M = 29,
S_1G = 30
}
Enumerator S_32
Enumerator S_64
Enumerator S_128
Enumerator S_256
Enumerator S_512
Enumerator S_1024
Enumerator S_2048
Enumerator S_4096
Enumerator S_8192
Enumerator S_16384
Enumerator S_32768
Enumerator S_65536
Enumerator S_131072
Enumerator S_262144
Enumerator S_524288
Enumerator S_1048576
Enumerator S_2097152
Enumerator S_4194304
Enumerator S_8388608
Enumerator S_16777216
Enumerator S_33554432
Enumerator S_67108864
Enumerator S_134217728
Enumerator S_268435456
Enumerator S_536870912
Enumerator S_1073741824
Enumerator S_1K
Enumerator S_2K
Enumerator S_4K
Enumerator S_8K
Enumerator S_16K
Enumerator S_32K
Enumerator S_64K
Enumerator S_128K
Enumerator S_256K
Enumerator S_512K
Enumerator S_1M
Enumerator S_2M
Enumerator S_4M
Enumerator S_8M
Enumerator S_16M
Enumerator S_32M
Enumerator S_64M
Enumerator S_128M
Enumerator S_256M
Enumerator S_512M
Enumerator S_1G
Enumeration type ErrorType
Definition:
enum ErrorType {
Success,
InvalidParameter,
InvalidSettings,
Failed,
AnalysisUnavailableForProgramMode,
NotYetImplemented,
NoSolverLicenseAvailable = 10000,
ToolAlreadyOpen,
SequentialOnly,
NonSequentialOnly,
SingleNSCRayTraceSupported,
HPCNotAvailable,
FeatureNotSupported,
NotAvailableInLegacy
}
Enumerator Success
Enumerator InvalidParameter
Enumerator InvalidSettings
Enumerator Failed
Enumerator AnalysisUnavailableForProgramMode
Enumerator NotYetImplemented
Enumerator NoSolverLicenseAvailable
Enumerator ToolAlreadyOpen
Enumerator SequentialOnly
Enumerator NonSequentialOnly
Enumerator SingleNSCRayTraceSupported
Enumerator HPCNotAvailable
Enumerator FeatureNotSupported
Enumerator NotAvailableInLegacy
Enumeration type SurfaceCurvatureData
Definition:
enum SurfaceCurvatureData {
TangentialCurvature = 0,
SagittalCurvature = 1,
X_Curvature = 2,
Y_Curvature = 3,
CurvatureModulus = 4,
CurvatureUnused = 5
}
Enumerator TangentialCurvature
Enumerator SagittalCurvature
Enumerator X_Curvature
Enumerator Y_Curvature
Enumerator CurvatureModulus
Enumerator CurvatureUnused
Enumeration type SurfaceCurvatureCrossData
Definition:
enum SurfaceCurvatureCrossData {
TangentialCurvature = 0,
SagittalCurvature = 1,
X_Curvature = 2,
Y_Curvature = 3,
CurvatureModulus = 4,
CurvatureUnused = 5
}
Enumerator TangentialCurvature
Enumerator SagittalCurvature
Enumerator X_Curvature
Enumerator Y_Curvature
Enumerator CurvatureModulus
Enumerator CurvatureUnused
Enumeration type SurfacePhaseData
Definition:
enum SurfacePhaseData {
SurfacePhase = 0
}
Enumerator SurfacePhase
Enumeration type SurfaceSagData
Definition:
enum SurfaceSagData {
SurfaceSag = 0
}
Enumerator SurfaceSag
Enumeration type SurfaceSlopeData
Definition:
enum SurfaceSlopeData {
SurfaceSlope = 0,
TangentialSlope = 0,
SagittalSlope = 1,
XSlope = 2,
YSlope = 3,
SlopeModulus = 4,
SlopeUnused = 5
}
Enumerator SurfaceSlope
Enumerator TangentialSlope
Enumerator SagittalSlope
Enumerator XSlope
Enumerator YSlope
Enumerator SlopeModulus
Enumerator SlopeUnused
Enumeration type SurfaceSlopeCrossData
Definition:
enum SurfaceSlopeCrossData {
TangentialSlope = 0,
SagittalSlope = 1,
XSlope = 2,
YSlope = 3,
SlopeModulus = 4,
SlopeUnused = 5
}
Enumerator TangentialSlope
Enumerator SagittalSlope
Enumerator XSlope
Enumerator YSlope
Enumerator SlopeModulus
Enumerator SlopeUnused
Enumeration type SurfacePhaseSlopeData
Definition:
enum SurfacePhaseSlopeData {
PhaseSlopeTangential = 0,
PhaseSlopeSagittal = 1,
PhaseSlopeX = 2,
PhaseSlopeY = 3,
PhaseSlopeModulus = 4,
PhaseSlopeUnused = 5
}
Enumerator PhaseSlopeTangential
Enumerator PhaseSlopeSagittal
Enumerator PhaseSlopeX
Enumerator PhaseSlopeY
Enumerator PhaseSlopeModulus
Enumerator PhaseSlopeUnused
Enumeration type SurfacePhaseSlopeCrossData
Definition:
enum SurfacePhaseSlopeCrossData {
PhaseSlopeTangential = 0,
PhaseSlopeSagittal = 1,
PhaseSlopeX = 2,
PhaseSlopeY = 3,
PhaseSlopeModulus = 4,
PhaseSlopeUnused = 5
}
Enumerator PhaseSlopeTangential
Enumerator PhaseSlopeSagittal
Enumerator PhaseSlopeX
Enumerator PhaseSlopeY
Enumerator PhaseSlopeModulus
Enumerator PhaseSlopeUnused
Enumeration type RemoveOptions
Definition:
enum RemoveOptions {
None = 0,
BaseROC = 1,
BestFitSphere = 2,
BaseSag = 3,
CompositeSag = 4
}
Enumerator None
Enumerator BaseROC
Enumerator BestFitSphere
Enumerator BaseSag
Enumerator CompositeSag
Enumeration type BestFitSphereOptions
Definition:
enum BestFitSphereOptions {
MinimumVolume = 0,
MinimumRMS = 1,
MinimumRMSWithOffset = 2
}
Enumerator MinimumVolume
Enumerator MinimumRMS
Enumerator MinimumRMSWithOffset
Enumeration type SampleSizes
Definition:
enum SampleSizes {
S_32x32 = 1,
S_64x64 = 2,
S_128x128 = 3,
S_256x256 = 4,
S_512x512 = 5,
S_1024x1024 = 6,
S_2048x2048 = 7,
S_4096x4096 = 8,
S_8192x8192 = 9,
S_16384x16384 = 10
}
Enumerator S_32x32
Enumerator S_64x64
Enumerator S_128x128
Enumerator S_256x256
Enumerator S_512x512
Enumerator S_1024x1024
Enumerator S_2048x2048
Enumerator S_4096x4096
Enumerator S_8192x8192
Enumerator S_16384x16384
Enumeration type SampleSizes_Pow2Plus1
Definition:
enum SampleSizes_Pow2Plus1 {
S_33 = 1,
S_65 = 2,
S_129 = 3,
S_257 = 4,
S_513 = 5,
S_1025 = 6,
S_2049 = 7,
S_4097 = 8,
S_8193 = 9
}
Enumerator S_33
Enumerator S_65
Enumerator S_129
Enumerator S_257
Enumerator S_513
Enumerator S_1025
Enumerator S_2049
Enumerator S_4097
Enumerator S_8193
Enumeration type SampleSizes_Pow2Plus1_X
Definition:
enum SampleSizes_Pow2Plus1_X {
S_33x33 = 1,
S_65x65 = 2,
S_129x129 = 3,
S_257x257 = 4,
S_513x513 = 5,
S_1025x1025 = 6,
S_2049x2049 = 7,
S_4097x4097 = 8,
S_8193x8193 = 9
}
Enumerator S_33x33
Enumerator S_65x65
Enumerator S_129x129
Enumerator S_257x257
Enumerator S_513x513
Enumerator S_1025x1025
Enumerator S_2049x2049
Enumerator S_4097x4097
Enumerator S_8193x8193
Enumeration type SampleSizes_ContrastLoss
Definition:
enum SampleSizes_ContrastLoss {
S_3x3 = 1,
S_5x5 = 2,
S_7x7 = 3,
S_9x9 = 4,
S_11x11 = 5,
S_13x13 = 6,
S_15x15 = 7,
S_17x17 = 8,
S_19x19 = 9,
S_21x21 = 10,
S_23x23 = 11,
S_25x25 = 12,
S_27x27 = 13,
S_29x29 = 14,
S_31x31 = 15,
S_33x33 = 16,
S_35x35 = 17,
S_37x37 = 18,
S_39x39 = 19,
S_41x41 = 20,
S_43x43 = 21,
S_45x45 = 22,
S_47x47 = 23,
S_49x49 = 24,
S_51x51 = 25,
S_53x53 = 26,
S_55x55 = 27,
S_57x57 = 28,
S_59x59 = 29,
S_61x61 = 30,
S_63x63 = 31,
S_65x65 = 32,
S_67x67 = 33,
S_69x69 = 34,
S_71x71 = 35,
S_73x73 = 36,
S_75x75 = 37,
S_77x77 = 38,
S_79x79 = 39,
S_81x81 = 40,
S_83x83 = 41
}
Enumerator S_3x3
Enumerator S_5x5
Enumerator S_7x7
Enumerator S_9x9
Enumerator S_11x11
Enumerator S_13x13
Enumerator S_15x15
Enumerator S_17x17
Enumerator S_19x19
Enumerator S_21x21
Enumerator S_23x23
Enumerator S_25x25
Enumerator S_27x27
Enumerator S_29x29
Enumerator S_31x31
Enumerator S_33x33
Enumerator S_35x35
Enumerator S_37x37
Enumerator S_39x39
Enumerator S_41x41
Enumerator S_43x43
Enumerator S_45x45
Enumerator S_47x47
Enumerator S_49x49
Enumerator S_51x51
Enumerator S_53x53
Enumerator S_55x55
Enumerator S_57x57
Enumerator S_59x59
Enumerator S_61x61
Enumerator S_63x63
Enumerator S_65x65
Enumerator S_67x67
Enumerator S_69x69
Enumerator S_71x71
Enumerator S_73x73
Enumerator S_75x75
Enumerator S_77x77
Enumerator S_79x79
Enumerator S_81x81
Enumerator S_83x83
Enumeration type ShowAs
Definition:
enum ShowAs {
Surface,
Contour,
GreyScale,
InverseGreyScale,
FalseColor,
InverseFalseColor
}
Enumerator Surface
Enumerator Contour
Enumerator GreyScale
Enumerator InverseGreyScale
Enumerator FalseColor
Enumerator InverseFalseColor
Enumeration type DetectorViewerShowAsTypes
Definition:
enum DetectorViewerShowAsTypes {
FullListing = 0,
AzimuthCrossSection,
Text_CrossSection_Row = 1,
Text_CrossSection_Column,
FluxVsWaveLength,
GreyScale = 0,
GreyScale_Inverted,
FalseColor,
FalseColor_Inverted,
TrueColor,
Color_CrossSection_Row,
Color_CrossSection_Column,
Color_FluxVsWavelength,
CrossSection = 5,
Directivity_Full,
Directivity_Half,
CrossSection_Row = 4,
CrossSection_Column,
GeometricMtf = 6
}
Usage (see Example 10 for a full sample)
C#
// Open Detector Viewer, view previously saved .zrd file
IA_ DetectorView = TheSystem.Analyses.New_DetectorViewer();
IAS_DetectorViewer DetectorView_Settings = DetectorView.GetSettings() as IAS_DetectorViewer;
DetectorView_Settings.RayDatabaseFilename = "e10_API_RayTrace.ZRD";
DetectorView_Settings.ShowAs = DetectorViewerShowAsTypes.FalseColor;
DetectorView_Settings.Filter = "X_HIT(2, 4)"; // Detector will only display rays which hit object 2 exactly 4 times
DetectorView.ApplyAndWaitForCompletion(); // Apply Settings to Detector Viewer
C++
// Open Detector Viewer, view previously saved .zrd file
IA_Ptr DetectorView = TheSystem->Analyses->New_DetectorViewer();
IAS_DetectorViewerPtr DetectorView_Settings = DetectorView->GetSettings();
DetectorView_Settings->RayDatabaseFilename = "e10_API_Raytrace.ZRD";
DetectorView_Settings->ShowAs = DetectorViewerShowAsTypes_FalseColor;
// Detector will only display rays which hit object 2 exactly 4 times
DetectorView_Settings->Filter = "X_HIT(2, 4)";
// Apply Settings to Detector Viewer
DetectorView->ApplyAndWaitForCompletion();
Matlab
% Open Detector Viewer, view previously saved .zrd file
DetectorView = TheSystem.Analyses.New_DetectorViewer();
DetectorView_Settings = DetectorView.GetSettings();
DetectorView_Settings.RayDatabaseFilename = 'e10_API_Raytrace.ZRD';
DetectorView_Settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.FalseColor;
DetectorView_Settings.Filter = 'X_HIT(2, 4)'; % Detector will only display rays which hit object 2 exactly 4 times
DetectorView.ApplyAndWaitForCompletion(); % Apply Settings to Detector Viewer
Python
# Open Detector Viewer, view previously saved .zrd file
DetectorView = TheSystem.Analyses.New_DetectorViewer()
DetectorView_Settings = DetectorView.GetSettings()
DetectorView_Settings.RayDatabaseFilename = "e10_API_Raytrace.ZRD"
DetectorView_Settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.FalseColor
DetectorView_Settings.Filter = "X_HIT(2, 4)" # Detector will only display rays which hit object 2 exactly 4 times
DetectorView.ApplyAndWaitForCompletion() # Apply Settings to Detector Viewer
Enumerator FullListing
Enumerator AzimuthCrossSection
Enumerator Text_CrossSection_Row
Enumerator Text_CrossSection_Column
Enumerator FluxVsWaveLength
Enumerator GreyScale
Enumerator GreyScale_Inverted
Enumerator FalseColor
Enumerator FalseColor_Inverted
Enumerator TrueColor
Enumerator Color_CrossSection_Row
Enumerator Color_CrossSection_Column
Enumerator Color_FluxVsWavelength
Enumerator CrossSection
Enumerator Directivity_Full
Enumerator Directivity_Half
Enumerator CrossSection_Row
Enumerator CrossSection_Column
Enumerator GeometricMtf
Enumeration type DetectorViewerShowDataTypes
Definition:
enum DetectorViewerShowDataTypes {
IncidentFlux,
AbsorbedFlux,
AbsorbedFluxVolume,
PositionSpace = 0,
AngleSpace,
Polar_AngleSpace = 0,
IncoherentIrradiance = 0,
CoherentIrradiance,
CoherentPhase,
RadiantIntensity,
RadiancePositionSpace,
RadianceAngleSpace,
IncoherentIlluminance = 0,
CoherentIlluminance,
LuminousIntensity = 3,
LuminancePositionSpace,
LuminanceAngleSpace,
IncoherentFluence = 0,
CoherentFluence
}
Enumerator IncidentFlux
Enumerator AbsorbedFlux
Enumerator AbsorbedFluxVolume
Enumerator PositionSpace
Enumerator AngleSpace
Enumerator Polar_AngleSpace
Enumerator IncoherentIrradiance
Enumerator CoherentIrradiance
Enumerator CoherentPhase
Enumerator RadiantIntensity
Enumerator RadiancePositionSpace
Enumerator RadianceAngleSpace
Enumerator IncoherentIlluminance
Enumerator CoherentIlluminance
Enumerator LuminousIntensity
Enumerator LuminancePositionSpace
Enumerator LuminanceAngleSpace
Enumerator IncoherentFluence
Enumerator CoherentFluence
Enumeration type HuygensSurfaceMftShowAsTypes
Definition:
enum HuygensSurfaceMftShowAsTypes {
GreyScale,
InverseGreyScale,
FalseColor,
InverseFalseColor
}
Enumerator GreyScale
Enumerator InverseGreyScale
Enumerator FalseColor
Enumerator InverseFalseColor
Enumeration type HuygensShowAsTypes
Definition:
enum HuygensShowAsTypes {
Surface,
Contour,
GreyScale,
InverseGreyScale,
FalseColor,
InverseFalseColor,
TrueColor
}
Enumerator Surface
Enumerator Contour
Enumerator GreyScale
Enumerator InverseGreyScale
Enumerator FalseColor
Enumerator InverseFalseColor
Enumerator TrueColor
Enumeration type Beam
Definition:
enum Beam {
Reference,
Configuration_1,
Configuration_2,
Configuration_3,
Configuration_4,
Configuration_5,
Configuration_6,
Configuration_7,
Configuration_8,
Configuration_9,
Configuration_10,
Configuration_11,
Configuration_12,
Configuration_13,
Configuration_14,
Configuration_15,
Configuration_16,
Configuration_17,
Configuration_18,
Configuration_19,
Configuration_20
}
Enumerator Reference
Enumerator Configuration_1
Enumerator Configuration_2
Enumerator Configuration_3
Enumerator Configuration_4
Enumerator Configuration_5
Enumerator Configuration_6
Enumerator Configuration_7
Enumerator Configuration_8
Enumerator Configuration_9
Enumerator Configuration_10
Enumerator Configuration_11
Enumerator Configuration_12
Enumerator Configuration_13
Enumerator Configuration_14
Enumerator Configuration_15
Enumerator Configuration_16
Enumerator Configuration_17
Enumerator Configuration_18
Enumerator Configuration_19
Enumerator Configuration_20
Enumeration type GiaShowAsTypes
Definition:
enum GiaShowAsTypes {
Surface,
Contour,
GreyScale,
InverseGreyScale,
FalseColor,
InverseFalseColor,
SpotDiagram,
CrossX,
CrossY
}
Enumerator Surface
Enumerator Contour
Enumerator GreyScale
Enumerator InverseGreyScale
Enumerator FalseColor
Enumerator InverseFalseColor
Enumerator SpotDiagram
Enumerator CrossX
Enumerator CrossY
Enumeration type UserAnalysisDataType
Definition:
enum UserAnalysisDataType {
None,
Line2D,
Grid,
GridRGB,
Text
}
Enumerator None
Enumerator Line2D
Enumerator Grid
Enumerator GridRGB
Enumerator Text
Enumeration type GridPlotType
Definition:
enum GridPlotType {
Surface,
Contour,
GrayScale,
InverseGrayScale,
FalseColor,
InverseFalseColor
}
