ZOSAPI.Editors.LDE Namespace Reference
Last update: 17.07.2025Classes | |
| interface | ICoatingPerformanceData |
| interface | ILDEApertureData |
| Surface properties aperture tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDECoatingData |
| Surface properties coatings tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDECoatingSettings |
| Coating settings for a specific layer. This interface can be accessed via the ILDECoatingData interface. More... | |
| interface | ILDECompositeData |
| Surface properties composite tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDEDrawData |
| Surface properties draw tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDEImportData |
| Surface properties import tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDEPhysicalOpticsData |
| Surface properties physical optics tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDERow |
| All data for a Lens Data Editor surface. This interface can be accessed via the ILensDataEditor interface. More... | |
| interface | ILDEScatteringData |
| Surface properties scattering tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDETiltDecenterData |
| Surface properties tilt/decenter data. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILDETool_AddCoatingsToAllSurfaces |
| interface | ILDETool_TiltDecenterElements |
| interface | ILDETypeData |
| Surface properties type tab. This interface can be accessed via the ILDERow interface. More... | |
| interface | ILensDataEditor |
| This interface defines all properties and methods needed to interact with the Lens Data Editor. This interface can be accessed via the IOpticalSystem interface. More... | |
| interface | ISTAR_ComponentRBMs |
| All STAR component data for a Lens Data Editor surface. More... | |
| interface | ISTAR_CoordinateTransform |
| interface | ISTAR_Data |
| All STAR data for a Lens Data Editor surface. This interface can be accessed via the ILDERow interface. More... | |
| interface | ISTAR_Decenters |
| interface | ISTAR_Deformation |
| interface | ISTAR_DeformationFits |
| interface | ISTAR_Deformations |
| All STAR deformation data for a Lens Data Editor surface. More... | |
| interface | ISTAR_DeformationsFEAData |
| interface | ISTAR_DirectIndex |
| All STAR direct refractive index data for a Lens Data Editor surface. More... | |
| interface | ISTAR_DirectIndexFEAData |
| Classes which implement this interface allow to handle refractive index FEA datasets. More... | |
| interface | ISTAR_DirectIndexFits |
| interface | ISTAR_FEAFitResults |
| interface | ISTAR_FEAFitSettings |
| interface | ISTAR_PointWithDeformation |
| interface | ISTAR_PointWithDeformationAndWeight |
| interface | ISTAR_PointWithIndex |
| interface | ISTAR_PointWithTemperatureAndIndex |
| interface | ISTAR_RBM_Centroid |
| interface | ISTAR_RBM_ReferencePoint |
| interface | ISTAR_RBMs |
| interface | ISTAR_RotationAngles |
| interface | ISTAR_Rotations |
| interface | ISTAR_RotationValues |
| interface | ISTAR_Temperatures |
| All STAR temperature data for a Lens Data Editor surface. More... | |
| interface | ISTAR_TemperaturesFEAData |
| interface | ISTAR_TemperaturesFits |
| interface | ISurface |
| interface | ISurfaceABCD |
| interface | ISurfaceAlternateEven |
| interface | ISurfaceAlternateOdd |
| interface | ISurfaceAnnularZernikeSag |
| interface | ISurfaceAPBC |
| interface | ISurfaceApertureCircular |
| Aperture Type - Circular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureElliptical |
| Aperture Type - Elliptical Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureFloating |
| Aperture Type - Floating Aperture. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureNone |
| Aperture Type - None. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureRectangular |
| Aperture Type - Rectangular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureSpider |
| Aperture Type - Spider. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceApertureType |
| Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from a ILDEApertureData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate aperture type settings. More... | |
| interface | ISurfaceApertureUser |
| Aperture Type - User Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface. More... | |
| interface | ISurfaceAtmospheric |
| interface | ISurfaceBiconic |
| interface | ISurfaceBiconicZernike |
| interface | ISurfaceBinary1 |
| interface | ISurfaceBinary2 |
| interface | ISurfaceBinary3 |
| interface | ISurfaceBinary4 |
| interface | ISurfaceBirefringentIn |
| interface | ISurfaceBirefringentOut |
| interface | ISurfaceBlackBoxLens |
| interface | ISurfaceChebyShv |
| interface | ISurfaceCoeff_P_NthEvenPower |
| interface | ISurfaceCoeff_P_NthPower |
| interface | ISurfaceCoeff_R_NthEvenPower |
| interface | ISurfaceCoeff_R_NthPower |
| interface | ISurfaceCoeff_X1P1X2P2_NthEvenPower |
| interface | ISurfaceCoeff_X_NthEvenPower |
| interface | ISurfaceCoeff_X_NthEvenPower_8 |
| interface | ISurfaceCoeff_Y_NthEvenPower |
| interface | ISurfaceCoeff_Y_NthEvenPower_8 |
| interface | ISurfaceConjugate |
| interface | ISurfaceCoordinateBreak |
| interface | ISurfaceCubicSpline |
| interface | ISurfaceCylinderFrensel |
| interface | ISurfaceCylinderFresnel |
| interface | ISurfaceData |
| interface | ISurfaceDiffractionGrating |
| interface | ISurfaceEllipticalGrating1 |
| interface | ISurfaceEllipticalGrating2 |
| interface | ISurfaceEvenAspheric |
| interface | ISurfaceExtendedAsphere |
| interface | ISurfaceExtendedCubicSpline |
| interface | ISurfaceExtendedFresnel |
| interface | ISurfaceExtendedOddAsphere |
| interface | ISurfaceExtendedPolynomial |
| interface | ISurfaceExtendedToroidalGrating |
| interface | ISurfaceFreeformNthZernike |
| interface | ISurfaceFreeformXYPolynomial |
| interface | ISurfaceFresnel |
| interface | ISurfaceGeneralizedFresnel |
| interface | ISurfaceGradient1 |
| interface | ISurfaceGradient10 |
| interface | ISurfaceGradient12 |
| interface | ISurfaceGradient2 |
| interface | ISurfaceGradient3 |
| interface | ISurfaceGradient4 |
| interface | ISurfaceGradient5 |
| interface | ISurfaceGradient6 |
| interface | ISurfaceGradient7 |
| interface | ISurfaceGradient9 |
| interface | ISurfaceGradium |
| interface | ISurfaceGridGradient |
| interface | ISurfaceGridPhase |
| interface | ISurfaceGridSag |
| interface | ISurfaceHologram1 |
| interface | ISurfaceHologram2 |
| interface | ISurfaceIrregular |
| interface | ISurfaceJonesMatrix |
| interface | ISurfaceNonSequential |
| interface | ISurfaceNthEvenOrderTerms |
| interface | ISurfaceNthOrderTerms |
| interface | ISurfaceNthThickness |
| interface | ISurfaceNthZernike |
| interface | ISurfaceOddAsphere |
| interface | ISurfaceOddCosine |
| interface | ISurfaceOffAxisConicFreeform |
| interface | ISurfaceOpticallyFabricatedHologram |
| interface | ISurfaceParaxial |
| interface | ISurfaceParaxialXY |
| interface | ISurfacePeriodic |
| interface | ISurfacePolynomial |
| interface | ISurfaceQTypeAsphere |
| interface | ISurfaceQTypeFreeform |
| interface | ISurfaceRadialGrating |
| interface | ISurfaceRadialNurbs |
| interface | ISurfaceRetroReflect |
| interface | ISurfaceScatteringABg |
| Surface Scattering - ABg. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringABgFile |
| Surface Scattering - ABg File. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringBSDF |
| Surface Scattering - BSDF. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringCatalog |
| Surface Scattering - IS Scatter Catalog. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringGaussian |
| Surface Scattering - Gaussian. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringLambertian |
| Surface Scattering - Lambertian. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringNone |
| Surface Scattering - None. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceScatteringType |
| Base interface for all surface scattering types. This interface can be retrieved from the ILDEScatteringData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate scattering type settings. More... | |
| interface | ISurfaceScatteringUser |
| Surface Scattering - User. This interface can be retrieved from the ILDEScatteringData interface. More... | |
| interface | ISurfaceSlide |
| interface | ISurfaceStandard |
| interface | ISurfaceSuperconic |
| interface | ISurfaceTilted |
| interface | ISurfaceToroidal |
| interface | ISurfaceToroidalGrat |
| interface | ISurfaceToroidalHologram |
| interface | ISurfaceToroidalNurbs |
| interface | ISurfaceTrueFreeform |
| interface | ISurfaceTypeSettings |
| This interface is used for selecting any files required by a surface, and for changing surface types. This interface can be accessed via the ILDERow interface. More... | |
| interface | ISurfaceVariableLineSpaceGrating |
| interface | ISurfaceXYPolynomial |
| interface | ISurfaceZernikeAnnularPhase |
| interface | ISurfaceZernikeFringePhase |
| interface | ISurfaceZernikeFringeSag |
| interface | ISurfaceZernikeStandardPhase |
| interface | ISurfaceZernikeStandardSag |
| interface | ISurfaceZonePlate |
Enumeration Type Documentation
◆ CoatingStatusType
◆ ConversionOrder
◆ CoordinateConversionResult
◆ CoordinateReturnType
◆ IndexDataType
◆ InterpolationMethod
◆ NodesDataType
◆ PilotRadiusMode
◆ PointCloudFileFormat
◆ PupilApodizationType
◆ QTypes
◆ STARDeformationOption
◆ SubstrateType
◆ SurfaceApertureTypes
Usage (see Example 19 for a full sample)
C#
// To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
ISurfaceApertureType Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(SurfaceApertureTypes.RectangularAperture);
Rect_Aper._S_RectangularAperture.XHalfWidth = 10;
Rect_Aper._S_RectangularAperture.YHalfWidth = 10;
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper);
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2;
Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from ...
Definition: InterfacesLDE.cs:4729
C++
// To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
ISurfaceApertureTypePtr Rect_Aper = TheLDE->GetSurfaceAt(2)->ApertureData->CreateApertureTypeSettings(SurfaceApertureTypes_RectangularAperture);
Rect_Aper->_S_RectangularAperture->XHalfWidth = 10;
Rect_Aper->_S_RectangularAperture->YHalfWidth = 10;
TheLDE->GetSurfaceAt(2)->ApertureData->ChangeApertureTypeSettings(Rect_Aper);
TheLDE->GetSurfaceAt(3)->ApertureData->PickupFrom = 2;
Matlab
% To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture);
Rect_Aper.S_RectangularAperture_.XHalfWidth = 10;
Rect_Aper.S_RectangularAperture_.YHalfWidth = 10;
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper);
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2;
Definition: InterfacesLDE.cs:8
Definition: InterfacesEditors.cs:12
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5
Python
# To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture)
Rect_Aper._S_RectangularAperture.XHalfWidth = 10
Rect_Aper._S_RectangularAperture.YHalfWidth = 10
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper)
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2
| Enumerator | |
|---|---|
| None | |
| CircularAperture | |
| CircularObscuration | |
| Spider | |
| RectangularAperture | |
| RectangularObscuration | |
| EllipticalAperture | |
| EllipticalObscuration | |
| UserAperture | |
| UserObscuration | |
| FloatingAperture | |
◆ SurfaceColumn
◆ SurfaceEdgeDraw
◆ SurfaceScatteringTypes
◆ SurfaceType
All available surface types.
Usage (see Example 19 for a full sample)
C#
// To change surface type, we need to first get an ISurfaceTypesettings and then assign it.
ISurfaceTypeSettings SurfaceType_CB = TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(SurfaceType.CoordinateBreak);
TheLDE.GetSurfaceAt(4).ChangeType(SurfaceType_CB);
This interface is used for selecting any files required by a surface, and for changing surface types....
Definition: InterfacesLDE.cs:746
SurfaceType
All available surface types.
Definition: InterfacesLDE.cs:27
C++
// To change surface type, we need to first get an ISurfaceTypesettings and then assign it.
ISurfaceTypeSettingsPtr SurfaceType_CB = TheLDE->GetSurfaceAt(4)->GetSurfaceTypeSettings(SurfaceType_CoordinateBreak);
TheLDE->GetSurfaceAt(4)->ChangeType(SurfaceType_CB);
Matlab
% To change surface type, we need to first get an ISurfaceTypesettings and then assign it.
SurfaceType_CB = TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.CoordinateBreak);
TheLDE.GetSurfaceAt(4).ChangeType(SurfaceType_CB);
Python
# To change surface type, we need to first get an ISurfaceTypesettings and then assign it.
SurfaceType_CB = TheLDE.GetSurfaceAt(4).GetSurfaceTypeSettings(ZOSAPI.Editors.LDE.SurfaceType.CoordinateBreak)
TheLDE.GetSurfaceAt(4).ChangeType(SurfaceType_CB)
