zosapi-stubs 1.1.0__py3-none-any.whl

ZOSAPI-stubs/Analysis/Data/__init__.pyi

@@ -0,0 +1,658 @@
+# Auto-generated by zosapi-stubgen — do not edit by hand.
+# Re-run `zosapi-stubgen` to refresh after an OpticStudio upgrade.
+from __future__ import annotations
+from typing import (
+    Any, Dict, Generic, Iterable, Iterator, List,
+    Optional, overload, Sequence, Set, Tuple, TypeVar, Union,
+)
+from enum import IntEnum, IntFlag
+from datetime import datetime, timedelta
+
+import ZOSAPI.Analysis
+import ZOSAPI.Common
+import ZOSAPI.Tools
+
+class IAR_:
+    """Properties and methods for retrieving analysis window data. This interface can be accessed via the IA_ interface. Note that not all analysis types currently return detailed results via this interface, however all analyses that support text output should support the GetTextFile method. See the OpticStudio manual for more information."""
+    @property
+    def MetaData(self) -> IAR_MetaData: ...
+    @property
+    def HeaderData(self) -> IAR_HeaderData: ...
+    @property
+    def NumberOfDataGrids(self) -> int: ...
+    @property
+    def DataGrids(self) -> List[IAR_DataGrid]: ...
+    @property
+    def NumberOfDataGridsRgb(self) -> int: ...
+    @property
+    def DataGridsRgb(self) -> List[IAR_DataGridRgb]: ...
+    @property
+    def NumberOfDataSeries(self) -> int: ...
+    @property
+    def DataSeries(self) -> List[IAR_DataSeries]: ...
+    @property
+    def NumberOfDataSeriesRgb(self) -> int: ...
+    @property
+    def DataSeriesRgb(self) -> List[IAR_DataSeriesRgb]: ...
+    @property
+    def NumberOfDataScatterPoints(self) -> int: ...
+    @property
+    def DataScatterPoints(self) -> List[IAR_DataScatterPoints]: ...
+    @property
+    def NumberOfDataScatterPointsRgb(self) -> int: ...
+    @property
+    def DataScatterPointsRgb(self) -> List[IAR_DataScatterPointsRgb]: ...
+    @property
+    def NumberOfRayData(self) -> int: ...
+    @property
+    def RayData(self) -> List[IAR_RayData]: ...
+    @property
+    def CriticalRayData(self) -> IAR_CriticalRayData: ...
+    @property
+    def PathAnalysisData(self) -> IAR_PathAnalysisData: ...
+    @property
+    def SpotData(self) -> IAR_SpotDataResultMatrix: ...
+    @property
+    def NumberOfMessages(self) -> int: ...
+    @property
+    def Messages(self) -> List[ZOSAPI.Analysis.IMessage]: ...
+    def GetDataGrid(self, index: int) -> IAR_DataGrid: ...
+    def GetDataGridRgb(self, index: int) -> IAR_DataGridRgb: ...
+    def GetDataScatterPoint(self, index: int) -> IAR_DataScatterPoints: ...
+    def GetDataScatterPointRgb(self, index: int) -> IAR_DataScatterPointsRgb: ...
+    def GetDataSeries(self, index: int) -> IAR_DataSeries: ...
+    def GetDataSeriesRgb(self, index: int) -> IAR_DataSeriesRgb: ...
+    def GetMessageAt(self, index: int) -> ZOSAPI.Analysis.IMessage: ...
+    def GetRayData(self, index: int) -> IAR_RayData: ...
+    def GetTextFile(self, Filename: str) -> bool:
+        """This function provides similar functionality to the DDE and ZPL commands GETTEXTFILE
+
+        Args:
+            Filename: The output filename to store the text results data.
+
+        Returns:
+            true if the output file was successfully created; otherwise, false.
+        """
+        ...
+
+class IAR_CriticalRayData:
+    @property
+    def NumRays(self) -> int: ...
+    @property
+    def HeaderLabels(self) -> List[str]: ...
+    @property
+    def Rays(self) -> List[IAR_CriticalRayInfo]: ...
+    def GetRay(self, idx: int) -> IAR_CriticalRayInfo:
+        """Gets the specified ray.
+
+        Args:
+            idx: The index (0 to NumRays-1).
+        """
+        ...
+
+class IAR_CriticalRayInfo:
+    @property
+    def FieldPoint(self) -> int: ...
+    @property
+    def RayType(self) -> ZOSAPI.Tools.CriticalRayType: ...
+    @property
+    def Pass(self) -> bool: ...
+    @property
+    def TerminationObject(self) -> int: ...
+    @property
+    def Wavelength(self) -> float: ...
+    @property
+    def XIn(self) -> float: ...
+    @property
+    def YIn(self) -> float: ...
+    @property
+    def ZIn(self) -> float: ...
+    @property
+    def LIn(self) -> float: ...
+    @property
+    def MIn(self) -> float: ...
+    @property
+    def NIn(self) -> float: ...
+    @property
+    def XTarget(self) -> float: ...
+    @property
+    def YTarget(self) -> float: ...
+    @property
+    def ZTarget(self) -> float: ...
+    @property
+    def LTarget(self) -> float: ...
+    @property
+    def MTarget(self) -> float: ...
+    @property
+    def NTarget(self) -> float: ...
+    @property
+    def XActual(self) -> float: ...
+    @property
+    def YActual(self) -> float: ...
+    @property
+    def ZActual(self) -> float: ...
+    @property
+    def LActual(self) -> float: ...
+    @property
+    def MActual(self) -> float: ...
+    @property
+    def NActual(self) -> float: ...
+
+class IAR_DataGrid:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def YLabel(self) -> str: ...
+    @property
+    def ValueLabel(self) -> str: ...
+    @property
+    def Nx(self) -> int: ...
+    @property
+    def Ny(self) -> int: ...
+    @property
+    def Dx(self) -> float: ...
+    @property
+    def Dy(self) -> float: ...
+    @property
+    def MinX(self) -> float: ...
+    @property
+    def MinY(self) -> float: ...
+    @property
+    def Values(self) -> List[float]: ...
+    @property
+    def ValueData(self) -> ZOSAPI.Common.IMatrixData: ...
+    def ConvertToRGB(self, translator: ZOSAPI.Analysis.IColorTranslator) -> IAR_DataGridRgb: ...
+    def X(self, rowX: int) -> float: ...
+    def XYZ(self, rowX: int, colY: int) -> IAR_XYZ: ...
+    def Y(self, colY: int) -> float: ...
+    def Z(self, rowX: int, colY: int) -> float: ...
+
+class IAR_DataGridRgb:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def YLabel(self) -> str: ...
+    @property
+    def ValueLabel(self) -> str: ...
+    @property
+    def Nx(self) -> int: ...
+    @property
+    def Ny(self) -> int: ...
+    @property
+    def Dx(self) -> float: ...
+    @property
+    def Dy(self) -> float: ...
+    @property
+    def MinX(self) -> float: ...
+    @property
+    def MinY(self) -> float: ...
+    @property
+    def Values(self) -> List[IAR_Rgb]: ...
+    def FillValues(self, fullSize: int) -> Tuple[List[float], List[float], List[float]]:
+        """Retries all RGB data at once, into the specified buffers.
+
+        Args:
+            fullSize: The full size (Nx * Ny).
+            rData: The r data.
+            gData: The g data.
+            bData: The b data.
+        """
+        ...
+    def GetValue(self, x: int, y: int) -> IAR_Rgb:
+        """Gets the specified point.
+
+        Args:
+            x: The row (0 to Nx-1).
+            y: The col (0 to Ny-1).
+        """
+        ...
+
+class IAR_DataGridVector:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def YLabel(self) -> str: ...
+    @property
+    def ValueLabel(self) -> str: ...
+    @property
+    def Nx(self) -> int: ...
+    @property
+    def Ny(self) -> int: ...
+    @property
+    def Dx(self) -> float: ...
+    @property
+    def Dy(self) -> float: ...
+    @property
+    def MinX(self) -> float: ...
+    @property
+    def MinY(self) -> float: ...
+    @property
+    def DeltaXValues(self) -> List[float]: ...
+    @property
+    def DeltaYValues(self) -> List[float]: ...
+    @property
+    def DeltaXValueData(self) -> ZOSAPI.Common.IMatrixData: ...
+    @property
+    def DeltaYValueData(self) -> ZOSAPI.Common.IMatrixData: ...
+    def DeltaX(self, rowX: int, colY: int) -> float: ...
+    def DeltaY(self, rowX: int, colY: int) -> float: ...
+    def X(self, rowX: int) -> float: ...
+    def Y(self, colY: int) -> float: ...
+
+class IAR_DataScatterPoints:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def NumPoints(self) -> int: ...
+    @property
+    def Points(self) -> List[IAR_ScatterPoint]: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def YLabel(self) -> str: ...
+    @property
+    def ValueLabel(self) -> str: ...
+    def ConvertToRGB(self, translator: ZOSAPI.Analysis.IColorTranslator) -> IAR_DataScatterPointsRgb: ...
+    def FillPointValues(self, fullSize: int) -> Tuple[List[float], List[float], List[float]]:
+        """Retries all scatter data at once, into the specified buffers.
+
+        Args:
+            fullSize: The full size (same as NumPoints).
+            xData: The x data.
+            yData: The y data.
+            valueData: The value data.
+        """
+        ...
+    def GetPoint(self, idx: int) -> IAR_ScatterPoint:
+        """Gets the specified point.
+
+        Args:
+            idx: The index (0 to NumPoints-1).
+        """
+        ...
+
+class IAR_DataScatterPointsRgb:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def NumPoints(self) -> int: ...
+    @property
+    def Points(self) -> List[IAR_ScatterPointRgb]: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def YLabel(self) -> str: ...
+    @property
+    def ValueLabel(self) -> str: ...
+    def FillPointValues(self, fullSize: int) -> Tuple[List[float], List[float], List[float], List[float], List[float]]:
+        """Retries all scatter data at once, into the specified buffers.
+
+        Args:
+            fullSize: The full size (same as NumPoints).
+            xData: The x data.
+            yData: The y data.
+            rData: The r data.
+            gData: The g data.
+            bData: The b data.
+        """
+        ...
+    def GetPoint(self, idx: int) -> IAR_ScatterPointRgb:
+        """Gets the specified point.
+
+        Args:
+            idx: The index (0 to NumPoints-1).
+        """
+        ...
+
+class IAR_DataSeries:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def XData(self) -> ZOSAPI.Common.IVectorData: ...
+    @property
+    def SeriesLabels(self) -> List[str]: ...
+    @property
+    def NumSeries(self) -> int: ...
+    @property
+    def YData(self) -> ZOSAPI.Common.IMatrixData: ...
+    def ConvertToRGB(self, translator: ZOSAPI.Analysis.IColorTranslator) -> IAR_DataSeriesRgb: ...
+
+class IAR_DataSeriesRgb:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def NumSeries(self) -> int: ...
+    @property
+    def XData(self) -> ZOSAPI.Common.IVectorData: ...
+    @property
+    def NumberOfRows(self) -> int: ...
+    @property
+    def YVals(self) -> List[IAR_Rgb]: ...
+    @property
+    def XLabel(self) -> str: ...
+    @property
+    def SeriesLabels(self) -> List[str]: ...
+    def FillYValues(self, fullSize: int) -> Tuple[List[float], List[float], List[float]]:
+        """Retries all RGB data at once, into the specified buffers.
+
+        Args:
+            fullSize: The full size (NumberOfRows * NumSeries).
+            rData: The r data.
+            gData: The g data.
+            bData: The b data.
+        """
+        ...
+    def GetYPoint(self, row: int, col: int) -> IAR_Rgb:
+        """Gets the specified point.
+
+        Args:
+            row: The row (0 to NumberOfRows-1).
+            col: The col (0 to NumSeries-1).
+        """
+        ...
+
+class IAR_HeaderData:
+    @property
+    def Lines(self) -> List[str]: ...
+
+class IAR_MetaData:
+    @property
+    def FeatureDescription(self) -> str: ...
+    @property
+    def LensFile(self) -> str: ...
+    @property
+    def LensTitle(self) -> str: ...
+    @property
+    def Date(self) -> datetime: ...
+
+class IAR_PathAnalysisData:
+    @property
+    def TotalFluxIn(self) -> float: ...
+    @property
+    def TotalFluxOut(self) -> float: ...
+    @property
+    def TotalRays(self) -> int: ...
+    @property
+    def TotalHits(self) -> int: ...
+    @property
+    def NumPaths(self) -> int: ...
+    @property
+    def Paths(self) -> List[IAR_PathAnalysisEntry]: ...
+    def GetPathNumber(self, idx: int) -> IAR_PathAnalysisEntry:
+        """Gets data for the specified path.
+
+        Args:
+            idx: The path number (1 to NumPaths).
+        """
+        ...
+
+class IAR_PathAnalysisEntry:
+    @property
+    def PathNumber(self) -> int: ...
+    @property
+    def RaysInPath(self) -> int: ...
+    @property
+    def HitsInPath(self) -> int: ...
+    @property
+    def GhostsInPath(self) -> int: ...
+    @property
+    def UniqueObjectsInPath(self) -> int: ...
+    @property
+    def TotalPathFlux(self) -> float: ...
+    @property
+    def NumberOfObjectsInPath(self) -> int: ...
+    @property
+    def PathObjectList(self) -> List[int]: ...
+    @property
+    def PathSource(self) -> int: ...
+    def GetPathObjectNumber(self, objectNumber: int) -> int: ...
+
+class IAR_RayData:
+    @property
+    def Description(self) -> str: ...
+    @property
+    def NumRays(self) -> int: ...
+    @property
+    def Rays(self) -> List[IAR_RayInfo]: ...
+    def GetRay(self, idx: int) -> IAR_RayInfo:
+        """Gets the specified ray.
+
+        Args:
+            idx: The index (0 to NumRays-1).
+        """
+        ...
+
+class IAR_RayInfo:
+    @property
+    def RayIndex(self) -> int:
+        """Indicates the source ray from which is the original ancestor for this segment"""
+        ...
+    @property
+    def Segment(self) -> int:
+        """Sequential from 0 to the total number of segments the generated from the origin ray"""
+        ...
+    @property
+    def Parent(self) -> int:
+        """Indicates which prior segment generated this one"""
+        ...
+    @property
+    def Level(self) -> int:
+        """Indicates how many segments this ray is away from the source ray"""
+        ...
+    @property
+    def In_object(self) -> int:
+        """Indicates which object the segment is traveling through"""
+        ...
+    @property
+    def Hit_object(self) -> int:
+        """Indicates which object the segment struck (if 0, the ray missed all objects and is terminated)"""
+        ...
+    @property
+    def Hit_face(self) -> int:
+        """Indicates which face the segment struck on the object"""
+        ...
+    @property
+    def X(self) -> float:
+        """Global X-coordinate of ray intercept"""
+        ...
+    @property
+    def Y(self) -> float:
+        """Global Y-coordinate of ray intercept"""
+        ...
+    @property
+    def Z(self) -> float:
+        """Global Z-coordinate of ray intercept"""
+        ...
+    @property
+    def L(self) -> float:
+        """Global X-direction cosine of the ray following the surface"""
+        ...
+    @property
+    def M(self) -> float:
+        """Global Y-direction cosine of the ray following the surface"""
+        ...
+    @property
+    def N(self) -> float:
+        """Global Z-direction cosine of the ray following the surface"""
+        ...
+    @property
+    def Nx(self) -> float:
+        """Global X-component of object normal vector at the ray segment-object intercept point"""
+        ...
+    @property
+    def Ny(self) -> float:
+        """Global Y-component of object normal vector at the ray segment-object intercept point"""
+        ...
+    @property
+    def Nz(self) -> float:
+        """Global Z-component of object normal vector at the ray segment-object intercept point"""
+        ...
+    @property
+    def Ex(self) -> float:
+        """Electric field X-component in global coordinate system"""
+        ...
+    @property
+    def Ey(self) -> float:
+        """Electric field Y-component in global coordinate system"""
+        ...
+    @property
+    def Ez(self) -> float:
+        """Electric field Z-component in global coordinate system"""
+        ...
+    @property
+    def PathLength(self) -> float:
+        """Ray path length from previous surface in lens-units"""
+        ...
+    @property
+    def OpticalPathLength(self) -> float:
+        """Ray optical path length (path*index of refraction) from previous surface in lens-units"""
+        ...
+    @property
+    def Wavelength(self) -> float:
+        """Wavelength in microns"""
+        ...
+    @property
+    def Vignetted(self) -> int:
+        """0 if not vignetted, else vignetted surface number"""
+        ...
+    @property
+    def Error(self) -> int:
+        """0 if no error"""
+        ...
+
+class IAR_Rgb:
+    @property
+    def R(self) -> float: ...
+    @property
+    def G(self) -> float: ...
+    @property
+    def B(self) -> float: ...
+
+class IAR_ScatterPoint:
+    @property
+    def X(self) -> float: ...
+    @property
+    def Y(self) -> float: ...
+    @property
+    def Value(self) -> float: ...
+
+class IAR_ScatterPointRgb:
+    @property
+    def X(self) -> float: ...
+    @property
+    def Y(self) -> float: ...
+    @property
+    def Value(self) -> IAR_Rgb: ...
+
+class IAR_SpotDataResult:
+    @property
+    def X(self) -> float: ...
+    @X.setter
+    def X(self, value: float) -> None: ...
+    @property
+    def Y(self) -> float: ...
+    @Y.setter
+    def Y(self, value: float) -> None: ...
+    @property
+    def Z(self) -> float: ...
+    @Z.setter
+    def Z(self, value: float) -> None: ...
+    @property
+    def L(self) -> float: ...
+    @L.setter
+    def L(self, value: float) -> None: ...
+    @property
+    def M(self) -> float: ...
+    @M.setter
+    def M(self, value: float) -> None: ...
+    @property
+    def N(self) -> float: ...
+    @N.setter
+    def N(self, value: float) -> None: ...
+    @property
+    def Detector_X(self) -> float: ...
+    @Detector_X.setter
+    def Detector_X(self, value: float) -> None: ...
+    @property
+    def Detector_Y(self) -> float: ...
+    @Detector_Y.setter
+    def Detector_Y(self, value: float) -> None: ...
+    @property
+    def Detector_Z(self) -> float: ...
+    @Detector_Z.setter
+    def Detector_Z(self, value: float) -> None: ...
+    @property
+    def RefCoord_X(self) -> float: ...
+    @RefCoord_X.setter
+    def RefCoord_X(self, value: float) -> None: ...
+    @property
+    def RefCoord_Y(self) -> float: ...
+    @RefCoord_Y.setter
+    def RefCoord_Y(self, value: float) -> None: ...
+    @property
+    def RMSSpot_X(self) -> float: ...
+    @RMSSpot_X.setter
+    def RMSSpot_X(self, value: float) -> None: ...
+    @property
+    def RMSSpot_Y(self) -> float: ...
+    @RMSSpot_Y.setter
+    def RMSSpot_Y(self, value: float) -> None: ...
+    @property
+    def RMSSpotSize(self) -> float: ...
+    @RMSSpotSize.setter
+    def RMSSpotSize(self, value: float) -> None: ...
+    @property
+    def GeoSpotSize(self) -> float: ...
+    @GeoSpotSize.setter
+    def GeoSpotSize(self, value: float) -> None: ...
+
+class IAR_SpotDataResultMatrix:
+    @property
+    def HalfWidth_X(self) -> float: ...
+    @property
+    def HalfWidth_Y(self) -> float: ...
+    @property
+    def MaxRadius(self) -> float: ...
+    @property
+    def MeanRadius(self) -> float: ...
+    @property
+    def NumberOfFields(self) -> int: ...
+    @property
+    def NumberOfWavelengths(self) -> int: ...
+    def GetDetector_X_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetDetector_Y_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetDetector_Z_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetGeoSpotSizeFor(self, fieldN: int, waveN: int) -> float: ...
+    def GetRMSSpotSizeFor(self, fieldN: int, waveN: int) -> float: ...
+    def GetRMSSpot_X_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetRMSSpot_Y_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetReferenceCoordinate_X_For(self, fieldN: int, waveN: int) -> float: ...
+    def GetReferenceCoordinate_Y_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_L_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_M_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_N_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_X_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_Y_For(self, fieldN: int, waveN: int) -> float: ...
+    def Get_Z_For(self, fieldN: int, waveN: int) -> float: ...
+
+class IAR_Vector2D:
+    @property
+    def dx(self) -> float: ...
+    @property
+    def dy(self) -> float: ...
+
+class IAR_XYZ:
+    @property
+    def X(self) -> float: ...
+    @property
+    def Y(self) -> float: ...
+    @property
+    def Z(self) -> float: ...