This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
The parameter which holds the data for the numerical setup of light sources. More...

Inheritance diagram for BasicParameter:

Public Types
enum	eApertureShape { Rectangular , Elliptic }
	Shape of the aperture: rectangular or elliptic. More...

Public Member Functions
	BasicParameter ()
	Constructor. Sets the type to Monochromatic.

override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance.

ApertureSettings	GetApertureSettings ()
	Gets the aperture settings.

void	SetApertureSettings (ApertureSettings apertureSettings)
	Sets the aperture settings.

Properties
double	ApertureEdgeWidth `[get, set]`
	Edge width of the aperture (absolute value).

double	ApertureRelativeEdgeWidth `[get, set]`
	Relative edge width of the aperture (with respect to field size).

eApertureShape	ApertureShape `[get, set]`
	Shape of the Aperture: Elliptic or rectangular.

VectorD	ApertureSize `[get, set]`
	Size of the aperture.

double	ApertureSizeFactor `[get, set]`
	Size factor (scaling) used for automatic definition of the aperture size.

bool	ApertureUseReleativeEdgeWidth `[get, set]`
	Flag that indicates whether the relative edge width is to be used instead of absolute edge width.

VectorD	ArraySize `[get]`
	Get the field size resulting from aperture size, edge width and lateral offset. The embedding frame is not considered.

bool	AutomaticAperture `[get, set]`
	Flag that indicates that the size of the aperture is computed automatically.

double	DistanceToOrigin `[get, set]`
	Distance of input plane to source plane.

int	EmbeddingSize `[get, set]`
	Size of the embedding frame in pixels.

bool	IsAutomaticApertureSupported `[get, set]`
	Gets and sets whether AutomaticAperture can be `true`.

VectorD	LateralOffset `[get, set]`
	Lateral offset of the field.

bool	ShiftField `[get, set]`
	Flag to indicate that the light source is shifted.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
The parameter which holds the data for the numerical setup of light sources.

Member Enumeration Documentation

◆ eApertureShape

enum eApertureShape

Shape of the aperture: rectangular or elliptic.

Enumerator
Rectangular	Rectangular aperture.
Elliptic	Elliptic aperture.

Member Function Documentation

◆ Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent
	)

Determines whether the specified Object is equal to this instance.

Parameters

otherObject	The Object to compare with this instance.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.

Returns: true if the specified Object is equal to this instance; otherwise, false.

◆ GetApertureSettings()

ApertureSettings GetApertureSettings ( )

Gets the aperture settings.

Returns: The aperture settings as one object.

◆ SetApertureSettings()

void SetApertureSettings ( ApertureSettings apertureSettings )

Sets the aperture settings.

Parameters

apertureSettings The aperture settings as one object.

Property Documentation

◆ IsAutomaticApertureSupported

bool IsAutomaticApertureSupported

getset

Gets and sets whether AutomaticAperture can be true.

Public Types

Public Member Functions

Properties