ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation Interface Reference

Public Member Functions
void	AutoCalculateBeamSampling ()
string	GetBeamTypeFileName (int fileIndex)
string[]	GetBeamTypeFiles ()
void	ReadPowerFromFile ()
string	GetParameterName (int paramIdx)
double	GetParameterValue (int paramIdx)
void	SetParameterValue (int paramIdx, double Value)
string	GetFiberTypeFileName (int fileIndex)
string[]	GetFiberTypeFiles ()
string	GetFiberParameterName (int paramIdx)
double	GetFiberParameterValue (int paramIdx)
void	SetFiberParameterValue (int paramIdx, double Value)
Public Member Functions inherited from ZOSAPI.Analysis.Settings.IAS_
IMessages	Verify ()
void	Save ()
	Saves the current settings to the default CFG file.
void	Load ()
	Loads settings from the default CFG file.
void	Reset ()
	Resets the settings back to the defaults for the current analysis.
bool	SaveTo (string settingsFile)
	Saves the current settings to the specified file.
bool	LoadFrom (string settingsFile)
	Replaces the current settings with settings read from the specified file.
bool	ModifySettings (string settingsFile, string typeCode, string newValue)
	Changes a single setting in the specified file. See the MODIFYSETTINGS DDE command help documentation for more information.

Properties
IAS_Wavelength	Wavelength [get]
IAS_Field	Field [get]
IAS_Surface	StartSurface [get]
	The default value 0 represents the Entrance Pupil.
IAS_Surface	EndSurface [get]
	The default value 0 represents the Image plane.
double	SurfaceToBeam [get, set]
bool	UsePolarization [get, set]
bool	SeparateXY [get, set]
bool	UseDiskStorage [get, set]
POPBeamTypes	BeamType [get, set]
SampleSizes	XSampling [get, set]
SampleSizes	YSampling [get, set]
double	XWidth [get, set]
double	YWidth [get, set]
bool	UseTotalPower [get, set]
double	TotalPower [get, set]
bool	UsePeakIrradiance [get, set]
double	PeakIrradiance [get, set]
int	NumberOfBeamTypeFiles [get]
string	BeamTypeFilename [get, set]
int	NumberOfParameters [get]
POPShowAsTypes	ShowAs [get, set]
POPDataTypes	DataType [get, set]
POPProjectionTypes	Project [get, set]
string	ContourFormat [get, set]
double	PlotScale [get, set]
POPScaleTypes	LogScale [get, set]
POPZoomTypes	ZoomIn [get, set]
int	RowOrColumn [get, set]
	0 = Center, 1-XSampling or 1-YSampling otherwise
double	ZeroPhaseLevel [get, set]
bool	SaveOutputBeam [get, set]
string	OutputBeamFile [get, set]
bool	SaveBeamAtAllSurfaces [get, set]
bool	ComputeFiberCouplingIntegral [get, set]
bool	IgnoreFiberPolarization [get, set]
POPFiberTypes	FiberType [get, set]
POPFiberPositions	FiberPosition [get, set]
double	TiltAboutX [get, set]
double	TiltAboutY [get, set]
int	NumberOfFiberTypeFiles [get]
string	FiberTypeFilename [get, set]
int	NumberOfFiberParameters [get]

Member Function Documentation

◆ AutoCalculateBeamSampling()

◆ GetBeamTypeFileName()

◆ GetBeamTypeFiles()

◆ GetFiberParameterName()

◆ GetFiberParameterValue()

◆ GetFiberTypeFileName()

◆ GetFiberTypeFiles()

◆ GetParameterName()

◆ GetParameterValue()

◆ ReadPowerFromFile()

◆ SetFiberParameterValue()

◆ SetParameterValue()

Property Documentation

◆ BeamType

◆ BeamTypeFilename

◆ ComputeFiberCouplingIntegral

◆ ContourFormat

◆ DataType

◆ EndSurface

◆ FiberPosition

◆ FiberType

◆ FiberTypeFilename

◆ Field

◆ IgnoreFiberPolarization

◆ LogScale

◆ NumberOfBeamTypeFiles

◆ NumberOfFiberParameters

◆ NumberOfFiberTypeFiles

◆ NumberOfParameters

◆ OutputBeamFile

◆ PeakIrradiance

◆ PlotScale

◆ Project

◆ RowOrColumn

◆ SaveBeamAtAllSurfaces

◆ SaveOutputBeam

◆ SeparateXY

◆ ShowAs

◆ StartSurface

◆ SurfaceToBeam

◆ TiltAboutX

◆ TiltAboutY

◆ TotalPower

◆ UseDiskStorage

◆ UsePeakIrradiance

◆ UsePolarization

◆ UseTotalPower

◆ Wavelength

◆ XSampling

◆ XWidth

◆ YSampling

◆ YWidth

◆ ZeroPhaseLevel

◆ ZoomIn