Class ChromaticFieldsSetBase

Namespace

VirtualLabAPI.Core.FieldRepresentations

Assembly

VirtualLabAPI.dll

Abstract base class for a Chromatic Fields Set (can be 1D or 2D)

[Serializable]
public abstract class ChromaticFieldsSetBase : DocumentBase, ISerializable, IDeserializationCallback, IDocument, IEquatable<IObjectBase>, ICloneable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

DocumentBase

ChromaticFieldsSetBase

Implements

ISerializable

IDeserializationCallback

IDocument

IEquatable<IObjectBase>

ICloneable

Derived

ChromaticFieldsSet

ChromaticFieldsSet_1D

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

FileHandlingSupport.SaveCompressed(IStorableOnHDD, string, ListOfSavedViewSettings)

Constructors

ChromaticFieldsSetBase(List<double>, ChromaticFieldsSetType, bool)

standard constructor

public ChromaticFieldsSetBase(List<double> wavelengths, ChromaticFieldsSetType typeOfChromaticFieldsSet, bool spectrumIsDiscrete)

Parameters

wavelengths List<double>

the list of wavelength which shall be stores within the ChromaticFieldsSet

typeOfChromaticFieldsSet ChromaticFieldsSetType

additional information of the type of the chromatic fields set

spectrumIsDiscrete bool

additional information to define whether the wavelengths information within the chromatic fields set shall be interpreted discrete or continuous

ChromaticFieldsSetBase(ChromaticFieldsSetBase)

Copy constructor

public ChromaticFieldsSetBase(ChromaticFieldsSetBase chromaticFieldsSet)

Parameters

chromaticFieldsSet ChromaticFieldsSetBase

ChromaticFieldsSetBase to copy

Properties

FileExtension

Extension for saved files

public override string FileExtension { get; }

Property Value

string

IsDiscreteSpectrum

public property to get and set whether the Wavelengths shall be interpreted discrete (true) or continuous (false) spectrum.

public bool IsDiscreteSpectrum { get; set; }

Property Value

bool

IsOneD

abstract property to get whether the chromatic fields set is 1D, or 2D

public bool IsOneD { get; }

Property Value

bool

PhysicalObjectDescriptionForView

Public property to get the description string for the physical object information in the chromatic fields set view.

public string PhysicalObjectDescriptionForView { get; }

Property Value

string

StoredDataSets

The underlying data as DataArrayBase.

public abstract DataArrayBase StoredDataSets { get; }

Property Value

DataArrayBase

TypeOfChromaticFieldsSet

Gets or sets the type of this chromatic fields set.

public ChromaticFieldsSetType TypeOfChromaticFieldsSet { get; set; }

Property Value

ChromaticFieldsSetType

TypeOfDocument

The type of the document.

public override DocumentType TypeOfDocument { get; }

Property Value

DocumentType

Wavelengths

Gets and sets the wavelength list of the ChromaticFieldsSet

public List<double> Wavelengths { get; set; }

Property Value

List<double>

Methods

Clone()

Clones the current object.

public override object Clone()

Returns

object

Deep copy of this object.

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.

GetSumOfAllSubsets()

Calculates a DataArray with a single subset containing the sum of all subsets of this

public abstract DataArrayBase GetSumOfAllSubsets()

Returns

DataArrayBase

DataArray with a single subset containing the sum of all subsets of this

ToString()

overridden to string method of the chromatic fields set class

public override string ToString()

Returns

string

the string description of the chromatic fields set class

getCorrectMeasuredQuantity(ChromaticFieldsSetType)

Gets the correct measured quantity per wavelength.

protected static MeasuredQuantity getCorrectMeasuredQuantity(ChromaticFieldsSetType chromaticFieldsSetType)

Parameters

chromaticFieldsSetType ChromaticFieldsSetType

Type of the chromatic fields set.

Returns

MeasuredQuantity

The matching measured quantity per wavelength.

getDescriptionAndQuantityForSum(out string, out MeasuredQuantity)

Gets the description and quantity if the data sets are integrated over wavelength.

protected void getDescriptionAndQuantityForSum(out string description, out MeasuredQuantity measuredQuantity)

Parameters

description string

The description of the result.

measuredQuantity MeasuredQuantity

The measured quantity of the result.