skZemax API Documentation

skZemax is essentially one large class which provides an interface layer on top of the native ZOS-API packages of the Zemax software (ZOS-API Application).

For organizational purposes only, all of the skZemax class functions are sorted in different categories below.

Main Functions

• Analysis Functions
  • Analyses_ExtractSectionOfTextFile()
  • Analyses_FFTMTF()
  • Analyses_Footprint()
  • Analyses_GetNamesOfAllAnalyses()
  • Analyses_ReportSurfacePrescription()
  • Analyses_ReportSystemPrescription()
  • Analyses_RunAnalysesAndGetResults()
• Analysis Plotting Functions
  • AnalysesPlotting_FFTMTF()
  • AnalysesPlotting_LinePlotByField()
  • AnalysisPlotting_Footprint()
  • get_colormap()
• CAD Model Functions
  • CAD_ExportSequentialCadSTPFileAs()
• Field Functions
  • Field_ClearVignettingFactors()
  • Field_DeleteField()
  • Field_GetAllDataOfField()
  • Field_GetField()
  • Field_GetFieldType()
  • Field_GetNormalization()
  • Field_SetAllDataOfFieldFromDict()
  • Field_SetFieldType()
  • Field_SetNormalization()
  • Field_SetVignettingFactors()
  • Fields_AddField()
  • Fields_GetNumberOfFields()
• Lens Data Editor (LDE) Functions
  • LDE_AddNewSurface()
  • LDE_BuildRayTraceNormalizedUnpolarizedRays()
  • LDE_ChangeApertureToCircular()
  • LDE_ChangeApertureToCircularObscuration()
  • LDE_ChangeApertureToFloating()
  • LDE_ChangeApertureToRectangular()
  • LDE_ChangeSurfaceType()
  • LDE_CheckIfSurfaceIsStop()
  • LDE_CopyAndInsertSurfacesFromFile()
  • LDE_GetAllColumnDataOfSurface()
  • LDE_GetApertureAsCircularObscurationType()
  • LDE_GetApertureAsCircularType()
  • LDE_GetApertureAsRectangularType()
  • LDE_GetApertureTypeSettings()
  • LDE_GetNamesOfAllApertureTypes()
  • LDE_GetNamesOfAllSurfaceTypes()
  • LDE_GetNumberOfSurfaces()
  • LDE_GetObjectRotationAndPositionMatrices()
  • LDE_GetStopSurface()
  • LDE_GetSurface()
  • LDE_GetSurfaceApertureType()
  • LDE_GetSurfaceColumnEnum()
  • LDE_InsertNewSurface()
  • LDE_RemoveSurface()
  • LDE_RunRayTrace()
  • LDE_SetAllColumnDataOfSurfaceFromDict()
  • LDE_SetSurfaceAsStop()
  • LDE_SetTiltDecenterAfterSurfaceMode()
  • LDE_SetTiltDecenterOfSurface()
• Multi-Configuration Editor (MCE) Functions
  • MCE_AddConfig()
  • MCE_AddConfigOperand()
  • MCE_DeleteConfig()
  • MCE_DeleteConfigOperand()
  • MCE_GetConfigOperand()
  • MCE_GetCurrentConfig()
  • MCE_GetCurrentNumOperands()
  • MCE_GetNumberOfConfigs()
  • MCE_InsertConfig()
  • MCE_InsertConfigOperand()
  • MCE_MakeAllSingleConfig()
  • MCE_SetActiveConfig()
  • MCE_SetOperand()
• Merit Function Editor (MFE) Functions
  • MFE_AddNewOperand()
  • MFE_GetNumberOfOperands()
  • MFE_GetOperand()
  • MFE_GetOperandValues()
  • MFE_InsertNewOperand()
  • MFE_SetOperand()
• Non-sequential Component Editor (NCE) Detector Functions
  • NCE_GetDetectorComplete()
  • NCE_GetDetectorLocations()
  • NCE_LoadDetectorInZemaxFormat()
  • NCE_SaveDetectorInZemaxFormat()
• Non-sequential Component Editor (NCE) Functions
  • NCE_AddNewObject()
  • NCE_ChangeObjectType()
  • NCE_ColocateObject()
  • NCE_GetAllColumnDataOfObject()
  • NCE_GetNumberOfObjects()
  • NCE_GetObject()
  • NCE_GetObjectColumnEnum()
  • NCE_GetObjectRotationAndPositionMatrices()
  • NCE_InsertNewObject()
  • NCE_ReadZDRFile()
  • NCE_RemoveObject()
  • NCE_RunRayTrace()
  • NCE_SetAllColumnDataOfObjectFromDict()
• Ray Aiming Functions
  • RayAiming_GetNamesOfAllAimingMethods()
  • RayAiming_GetNamesOfAllAimingProperties()
  • RayAiming_SetAimingMethod()
  • RayAiming_SetAimingProperty()
• Solver Functions
  • Solver_GetNamesOfAllSolveTypes()
  • Solver_HammerOptimization()
  • Solver_LDEMakeSurfacePropertyFixed()
  • Solver_LDEMakeSurfacePropertyVariable()
  • Solver_LDESurfaceProperty_ForValue()
  • Solver_LocalOptimization()
  • Solver_MCEMakeConfigOpVariable()
  • Solver_MCEMakeConfigOp_ForValue()
  • Solver_QuickFocus_SpotSize()
• System Functions
  • System_AddMaterialCatalog()
  • System_ConvertSequentialToNonSequential()
  • System_GetIfInNonSequentialMode()
  • System_GetIfInSequentialMode()
  • System_GetMode()
  • System_GetNamesOfAllApertureSettings()
  • System_GetNamesOfAllMaterialCatalogs()
  • System_Lockdown()
  • System_SetAdvancedProperty()
  • System_SetApertureProperty()
  • System_SetEnvironmentProperty()
  • System_SetGlobalCoordinateReferenceSurface()
  • System_SetNonSequentialMode()
  • System_SetPolarizationProperty()
  • System_SetSequentialMode()
• Utility Functions
  • Utilities_AnalysesFilesDir()
  • Utilities_ConfigFilesDir()
  • Utilities_DetectorFilesDir()
  • Utilities_GetAllSystemUnits()
  • Utilities_MainProgramDir()
  • Utilities_MakeNewZemaxFile()
  • Utilities_OpenZemaxFile()
  • Utilities_SaveZemaxFile()
  • Utilities_SaveZemaxFileAs()
  • Utilities_ZemaxInstallationCADObjectDir()
  • Utilities_ZemaxInstallationCoatingDir()
  • Utilities_ZemaxInstallationExampleDir()
  • Utilities_ZemaxInstallationImageDir()
  • Utilities_ZemaxInstallationMaterialDir()
  • Utilities_ZemaxInstallationPolygonObjectDir()
  • Utilities_ZemaxInstallationScatterDir()
  • Utilities_skZemaxExampleDir()
• Visualization Functions
  • Visualization_NSC_3DViewer()
  • Visualization_NSC_ShadedModel()
  • Visualization_SEQ_2DCrossSection()
  • Visualization_SEQ_3DViewer()
  • Visualization_SEQ_ShadedModel()
• Wavelength Functions
  • Wavelength_AddWavelength()
  • Wavelength_GetNamesOfAllPresets()
  • Wavelength_GetNumberOfWavelengths()
  • Wavelength_GetPrimaryWavelength()
  • Wavelength_GetWavelength()
  • Wavelength_RemoveWavelength()
  • Wavelength_SelectWavelengthPreset()
  • Wavelength_SetPrimaryWavelength()

Minor/Supporting Functions

• ZOS-API Application
  • PythonStandaloneApplication
• ZOS-API Interface Functions
  • _CheckIfStringValidInDir_()
  • _SetAttrByStringIfValid_()
  • __LowLevelZemaxStringCheck__()
  • _convert_raw_input_worker_()
  • _ctype_to_numpy_()
• Colored Printing
  • c_print()