Class BasicParameter

Namespace

VirtualLabAPI.Core.OpticalSystems

Assembly

VirtualLabAPI.dll

The parameter which holds the data for the numerical setup of light sources.

[Serializable]
public class BasicParameter : ManualSerialization, IEquatable<IObjectBase>, ISerializable, IDeserializationCallback, ICloneable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

BasicParameter

Implements

IEquatable<IObjectBase>

ISerializable

IDeserializationCallback

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BasicParameter()

Constructor. Sets the type to Monochromatic.

public BasicParameter()

Properties

ApertureShape

Shape of the Aperture: Elliptic or rectangular.

[Obsolete("Use GetApertureSettings / SetApertureSettings")]
public BasicParameter.eApertureShape ApertureShape { get; set; }

Property Value

BasicParameter.eApertureShape

ArraySize

Get the field size resulting from aperture size, edge width and lateral offset. The embedding frame is not considered.

public VectorD ArraySize { get; }

Property Value

VectorD

DistanceToOrigin

Distance of input plane to source plane.

public double DistanceToOrigin { get; set; }

Property Value

double

EmbeddingSize

Size of the embedding frame in pixels.

public int EmbeddingSize { get; set; }

Property Value

int

IsAutomaticApertureSupported

Gets and sets whether AutomaticAperture can be true.

public bool IsAutomaticApertureSupported { get; set; }

Property Value

bool

LateralOffset

Lateral offset of the field.

public VectorD LateralOffset { get; set; }

Property Value

VectorD

ShiftField

Flag to indicate that the light source is shifted.

public bool ShiftField { get; set; }

Property Value

bool

Methods

Equals(object, EqualityIntent)

Determines whether the specified object is equal to this instance.

public override bool Equals(object otherObject, EqualityIntent equalityIntent)

Parameters

otherObject object

The object to compare with this instance.

equalityIntent EqualityIntent

Defines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetApertureSettings()

Gets the aperture settings.

public ApertureSettings GetApertureSettings()

Returns

ApertureSettings

The aperture settings as one object.

SetApertureSettings(ApertureSettings)

Sets the aperture settings.

public void SetApertureSettings(ApertureSettings apertureSettings)

Parameters

apertureSettings ApertureSettings

The aperture settings as one object.