Below is an overview of ZOS-API commands used to retrieve STAR data. The syntax is the same for most programming languages.
The list is far from complete; see the ZOS-API help files for complete information.
Also,I have not included any info about establishing the .NET connection, because it differs for each software package; see the OpticStudio Programming tab for information on how to connect to OpticStudio through .NET.
myStarData = mySystem.LDE.GetSurfaceAt( j ).STARData - Top level container for all STAR data.
myStarData.Deformations - All structural data
myStarData.Deformations.CoordinateTransform - Holds info about any coordinate transform applied to the XYZ mesh. Data is available in angles or rotation matrices, or a complete 4x4 matrix that includes all decenters and rotations.
- myStarData.Deformations.CoordinateTransform.Enable()
- myStarData.Deformations.CoordinateTransform.IsEnabled
- myStarData.Deformations.CoordinateTransform.SetDecenter (dx, dy, dz)
- myStarData.Deformations.CoordinateTransform.SetRotationMatrix( R11, R12, …. R33)
- myStarData.Deformations.CoordinateTransform.SetTransformValues(R11, R12, …. R33, dx, dy, dz)
- myStarData.Deformations.CoordinateTransform.Decenters
- myStarData.Deformations.CoordinateTransform.Rotations
- myStarData.Deformations.CoordinateTransform.Transform
Transformation of a point {x,y,z} to get the new point {x’,y’,z’} is defined as follows:
myStarData.Deformations.FEAData - Holds the raw FEA data
- myStarData.Deformations.FEAData.ImportDeformations( filename )
- myStarData.Deformations.FEAData.AreDeformationsImported
- myStarData.Deformations.FEAData.NumberOfDataPoints
- myStarData.Deformations.FEAData.GetFEAPointsSafe()
myStarData.Deformations.Fits - Holds the fitted data
- myStarData.Deformations.Fits.IsSurfaceDeformationEnabled
- myStarData.Deformations.Fits.Options
- myStarData.Deformations.Fits.Settings
- myStarData.Deformations.Fits.GetFittedDeformation_1( x, y, option)
- option =DeformationWithoutRBMs, DeformationWithRBMs, NoDeformation, or OnlyRBMs
myStarData.Deformations.RBMs - Holds information about any Rigid-body Motions in the Deformation data
- myStarData.Deformations.RBMs.Enable()
- myStarData.Deformations.RBMs.IsEnabled
- myStarData.Deformations.RBMs.Decenters
- myStarData.Deformations.RBMs.Rotations
- myStarData.Deformations.RBMs.Transform
- myStarData.Deformations.RBMs.GetTransformValues()
myStarData.Temperatures - All thermal data
- myStarData.Temperatures.GRINStep
- myStarData.Temperatures.SetWorkingWavelength() – Defines the wavelength used to calculate an index of refraction
- myStarData.Temperatures.SetDataIsLocal()
- myStarData.Temperatures.SetDataIsGlobal()
myStarData.Temperatures.CoordinateTransform
- myStarData.Temperatures.CoordinateTransform.Enable()
- myStarData.Temperatures.CoordinateTransform.IsEnabled
- myStarData.Temperatures.CoordinateTransform.SetDecenter (dx, dy, dz)
- myStarData.Temperatures.CoordinateTransform.SetRotationMatrix( R11, R12, …. R33)
- myStarData.Temperatures.CoordinateTransform.SetTransformValues(R11, R12, …. R33, dx, dy, dz)
- myStarData.Temperatures.CoordinateTransform.Decenters
- myStarData.Temperatures.CoordinateTransform.Rotations
- myStarData.Temperatures.CoordinateTransform.Transform
myStarData.Temperatures.FEAData
- myStarData.Temperatures.FEAData.ImportTemperatures()
- myStarData.Temperatures.FEAData.AreTemperaturesImported
- myStarData.Temperatures.FEAData.NumberOfDataPoints
- myStarData.Temperatures.FEAData.GetFEAPointsSafe()
myStarData.Temperatures.Fits
- myStarData.Temperatures.Fits.IsTemperatureProfileEnabled
- myStarData.Temperatures.Fits.Settings
- myStarData.Temperatures.Fits.GetFittedIndex( x, y, z)
- myStarData.Temperatures.Fits.GetFittedTemperature( x, y, z)
