Inheritance diagram for ZOSAPI.Tools.General.IComputeRMSSpotSize:

Public Member Functions
void	SetMethodGaussianQuadrature (int numberOfRings, int numberOfArms, double obscuredFraction)
	Sets the pupil integration method to Gaussian quadrature.

void	SetMethodRectangularArray (int gridSampling, bool deleteVignetted)
	Sets the pupil integration method to grid sampling.

double	GetSpotRadius (int configuration, int field)
	Gets the output RMS spot radius for the given configuration and field (in lens units).

Public Member Functions inherited from ZOSAPI.Tools.ISystemTool
bool	Run ()
	Start the tool. Note that for synchronous tools (see IsAsynchronous), this call will block until completion. If it is asynchronous it will start running but return immediately.

bool	RunAndWaitForCompletion ()
	Sames as calling Run followed by WaitForCompletion.

bool	WaitForCompletion ()
	Waits for the asynchronous tool to complete.

bool	Cancel ()
	Cancels the currently running asynchronous tool.

bool	Close ()
	Closes this tool and frees up and associated resources.

RunStatus	WaitWithTimeout (double timeOutSeconds)
	Waits for the currently running tool to complete, with a specified time out value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. Also note that this method will not start the tool running if it is not already.

RunStatus	RunAndWaitWithTimeout (double timeOutSeconds)
	Starts the tool running, and waits for it to complete with the specified timeout value. Note that if the timeout is exceeded this method will return, however the tool will continue to run.

Properties
bool	UseGaussianQuadrature `[get]`

bool	UseRectangularArray `[get]`

int	NumberOfRings `[get]`

int	NumberOfArms `[get]`

double	ObscuredFration `[get]`

int	GridSampling `[get]`

bool	DeleteVignetted `[get]`

bool	AssumeAxialSymmetry `[get, set]`

bool	IgnoreLateralColor `[get, set]`

int	NumberOfConfigurations `[get]`
	Gets the number of output configurations.

int	NumberOfFields `[get]`
	Gets the number of output fields.

double[,]	RMSSpotRadii `[get]`
	Gets all output RMS spot radii (in lens units). Note that there will be (NumberOfConfigurations) rows by (NumberOfFields) columns.

Properties inherited from ZOSAPI.Tools.ISystemTool
int	Progress `[get]`
	Gets the progress of the current tool, if supported.

string	Status `[get]`
	Gets the status of the current tool, if supporoted.

bool	IsRunning `[get]`
	Gets a value indicating whether the tool is currently running asynchronously.

bool	CanCancel `[get]`
	Gets a value indicating whether the tool can be cancelled.

bool	IsAsynchronous `[get]`
	Gets a value indicating whether the tool runs asynchronously (i.e. on a thread).

bool	IsFiniteDuration `[get]`
	Gets a value indicating whether this tool will complete on its own.

bool	IsValid `[get]`
	Gets a value indicating whether the input settings are valid.

bool	Succeeded `[get]`
	Gets a value indicating whether the tool execution succeeded.

string	ErrorMessage `[get]`
	If Succeeded is `false`, get the error messages; otherwise, `null`.

Member Function Documentation

◆ GetSpotRadius()

double ZOSAPI.Tools.General.IComputeRMSSpotSize.GetSpotRadius	(	int	configuration,
		int	field
	)

Gets the output RMS spot radius for the given configuration and field (in lens units).

Parameters

configuration	The configuration (1 to NumberOfConfigurations).
field	The field (1 to NumberOfFields).

Returns

◆ SetMethodGaussianQuadrature()

void ZOSAPI.Tools.General.IComputeRMSSpotSize.SetMethodGaussianQuadrature	(	int	numberOfRings,
		int	numberOfArms,
		double	obscuredFraction
	)

Sets the pupil integration method to Gaussian quadrature.

Parameters

numberOfRings	The number of rings (1 - 20).
numberOfArms	The number of arms (6, 8, 10, 12).
obscuredFraction	The obscured fraction (0.0 - 1.0).

◆ SetMethodRectangularArray()

void ZOSAPI.Tools.General.IComputeRMSSpotSize.SetMethodRectangularArray	(	int	gridSampling,
		bool	deleteVignetted
	)

Sets the pupil integration method to grid sampling.

Parameters

gridSampling	The grid sampling (NxN, where N must be an even number from 4 - 204).
deleteVignetted	if set to `true` delete vignetted rays.

Property Documentation

◆ AssumeAxialSymmetry

bool ZOSAPI.Tools.General.IComputeRMSSpotSize.AssumeAxialSymmetry

getset

◆ DeleteVignetted

bool ZOSAPI.Tools.General.IComputeRMSSpotSize.DeleteVignetted

get

◆ GridSampling

int ZOSAPI.Tools.General.IComputeRMSSpotSize.GridSampling

get

◆ IgnoreLateralColor

bool ZOSAPI.Tools.General.IComputeRMSSpotSize.IgnoreLateralColor

getset

◆ NumberOfArms

int ZOSAPI.Tools.General.IComputeRMSSpotSize.NumberOfArms

get

◆ NumberOfConfigurations

int ZOSAPI.Tools.General.IComputeRMSSpotSize.NumberOfConfigurations

get

Gets the number of output configurations.

The number of configurations.

◆ NumberOfFields

int ZOSAPI.Tools.General.IComputeRMSSpotSize.NumberOfFields

get

Gets the number of output fields.

The number of fields.

◆ NumberOfRings

int ZOSAPI.Tools.General.IComputeRMSSpotSize.NumberOfRings

get

◆ ObscuredFration

double ZOSAPI.Tools.General.IComputeRMSSpotSize.ObscuredFration

get

◆ RMSSpotRadii

double [,] ZOSAPI.Tools.General.IComputeRMSSpotSize.RMSSpotRadii

get

Gets all output RMS spot radii (in lens units). Note that there will be (NumberOfConfigurations) rows by (NumberOfFields) columns.

The RMS spot radii.

◆ UseGaussianQuadrature

bool ZOSAPI.Tools.General.IComputeRMSSpotSize.UseGaussianQuadrature

get

◆ UseRectangularArray

bool ZOSAPI.Tools.General.IComputeRMSSpotSize.UseRectangularArray

get

ZOS-API interface 2024 R1

ZOSAPI.Tools.General.IComputeRMSSpotSize Interface Reference

Public Member Functions

Properties

Member Function Documentation

◆ GetSpotRadius()

◆ SetMethodGaussianQuadrature()

◆ SetMethodRectangularArray()

Property Documentation

◆ AssumeAxialSymmetry

◆ DeleteVignetted

◆ GridSampling

◆ IgnoreLateralColor

◆ NumberOfArms

◆ NumberOfConfigurations

◆ NumberOfFields

◆ NumberOfRings

◆ ObscuredFration

◆ RMSSpotRadii

◆ UseGaussianQuadrature

◆ UseRectangularArray

Connect with Ansys