Interface ZOSAPI::Analysis::PhysicalOptics::IAS_PhysicalOpticsPropagation

Definition:

Inherits from:

• ZOSAPI.Analysis.Settings.IAS_

Members

• AutoCalculateBeamSampling
• BeamType
• BeamTypeFilename
• ComputeFiberCouplingIntegral
• ContourFormat
• DataType
• EndSurface
• FiberPosition
• FiberType
• FiberTypeFilename
• Field
• GetBeamTypeFileName
• GetBeamTypeFiles
• GetFiberParameterName
• GetFiberParameterValue
• GetFiberTypeFileName
• GetFiberTypeFiles
• GetParameterName
• GetParameterValue
• IgnoreFiberPolarization
• Load
• LoadFrom
• LogScale
• ModifySettings
• NumberOfBeamTypeFiles
• NumberOfFiberParameters
• NumberOfFiberTypeFiles
• NumberOfParameters
• OutputBeamFile
• PeakIrradiance
• PlotScale
• Project
• ReadPowerFromFile
• Reset
• RowOrColumn
• Save
• SaveBeamAtAllSurfaces
• SaveOutputBeam
• SaveTo
• SeparateXY
• SetFiberParameterValue
• SetParameterValue
• ShowAs
• StartSurface
• SurfaceToBeam
• TiltAboutX
• TiltAboutY
• TotalPower
• UseDiskStorage
• UsePeakIrradiance
• UsePolarization
• UseTotalPower
• Verify
• Wavelength
• XSampling
• XWidth
• YSampling
• YWidth
• ZeroPhaseLevel
• ZoomIn

Properties

Property Wavelength

Definition:

IAS_Wavelength ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.Wavelength

Return type: IAS_Wavelength

Property Field

Definition:

IAS_Field ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.Field

Return type: IAS_Field

Property StartSurface

Definition:

IAS_Surface ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.StartSurface

The default value 0 represents the Entrance Pupil.

Return type: IAS_Surface

Property EndSurface

Definition:

IAS_Surface ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.EndSurface

The default value 0 represents the Image plane.

Return type: IAS_Surface

Property SurfaceToBeam

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SurfaceToBeam

Return type: double

Property UsePolarization

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.UsePolarization

Return type: bool

Property SeparateXY

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SeparateXY

Return type: bool

Property UseDiskStorage

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.UseDiskStorage

Return type: bool

Property BeamType

Definition:

POPBeamTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.BeamType

Return type: POPBeamTypes

Property XSampling

Definition:

SampleSizes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.XSampling

Return type: SampleSizes

Property YSampling

Definition:

SampleSizes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.YSampling

Return type: SampleSizes

Property XWidth

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.XWidth

Return type: double

Property YWidth

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.YWidth

Return type: double

Property UseTotalPower

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.UseTotalPower

Return type: bool

Property TotalPower

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.TotalPower

Return type: double

Property UsePeakIrradiance

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.UsePeakIrradiance

Return type: bool

Property PeakIrradiance

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.PeakIrradiance

Return type: double

Property NumberOfBeamTypeFiles

Definition:

int ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.NumberOfBeamTypeFiles

Return type: int

Property BeamTypeFilename

Definition:

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.BeamTypeFilename

Return type: string

Property NumberOfParameters

Definition:

int ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.NumberOfParameters

Return type: int

Property ShowAs

Definition:

POPShowAsTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ShowAs

Return type: POPShowAsTypes

Property DataType

Definition:

POPDataTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.DataType

Return type: POPDataTypes

Property Project

Definition:

POPProjectionTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.Project

Return type: POPProjectionTypes

Property ContourFormat

Definition:

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ContourFormat

Return type: string

Property PlotScale

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.PlotScale

Return type: double

Property LogScale

Definition:

POPScaleTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.LogScale

Return type: POPScaleTypes

Property ZoomIn

Definition:

POPZoomTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ZoomIn

Return type: POPZoomTypes

Property RowOrColumn

Definition:

int ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.RowOrColumn

0 = Center, 1-XSampling or 1-YSampling otherwise

Return type: int

Property ZeroPhaseLevel

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ZeroPhaseLevel

Return type: double

Property SaveOutputBeam

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SaveOutputBeam

Return type: bool

Property OutputBeamFile

Definition:

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.OutputBeamFile

Return type: string

Property SaveBeamAtAllSurfaces

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SaveBeamAtAllSurfaces

Return type: bool

Property ComputeFiberCouplingIntegral

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ComputeFiberCouplingIntegral

Return type: bool

Property IgnoreFiberPolarization

Definition:

bool ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.IgnoreFiberPolarization

Return type: bool

Property FiberType

Definition:

POPFiberTypes ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.FiberType

Return type: POPFiberTypes

Property FiberPosition

Definition:

POPFiberPositions ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.FiberPosition

Return type: POPFiberPositions

Property TiltAboutX

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.TiltAboutX

Return type: double

Property TiltAboutY

Definition:

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.TiltAboutY

Return type: double

Property NumberOfFiberTypeFiles

Definition:

int ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.NumberOfFiberTypeFiles

Return type: int

Property FiberTypeFilename

Definition:

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.FiberTypeFilename

Return type: string

Property NumberOfFiberParameters

Definition:

int ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.NumberOfFiberParameters

Return type: int

Public functions

Function AutoCalculateBeamSampling

void ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.AutoCalculateBeamSampling()

Return type: void

Function GetBeamTypeFileName

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetBeamTypeFileName(int fileIndex)

Parameters:

• int fileIndex

Return type: string

Function GetBeamTypeFiles

string[] ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetBeamTypeFiles()

Return type: string[]

Function ReadPowerFromFile

void ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.ReadPowerFromFile()

Return type: void

Function GetParameterName

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetParameterName(int paramIdx)

Parameters:

• int paramIdx

Return type: string

Function GetParameterValue

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetParameterValue(int paramIdx)

Parameters:

• int paramIdx

Return type: double

Function SetParameterValue

void ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SetParameterValue(int paramIdx, double Value)

Parameters:

• int paramIdx
• double Value

Return type: void

Function GetFiberTypeFileName

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetFiberTypeFileName(int fileIndex)

Parameters:

• int fileIndex

Return type: string

Function GetFiberTypeFiles

string[] ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetFiberTypeFiles()

Return type: string[]

Function GetFiberParameterName

string ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetFiberParameterName(int paramIdx)

Parameters:

• int paramIdx

Return type: string

Function GetFiberParameterValue

double ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.GetFiberParameterValue(int paramIdx)

Parameters:

• int paramIdx

Return type: double

Function SetFiberParameterValue

void ZOSAPI.Analysis.PhysicalOptics.IAS_PhysicalOpticsPropagation.SetFiberParameterValue(int paramIdx, double Value)

Parameters:

• int paramIdx
• double Value

Return type: void