ChromaticFieldsSet Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a two-dimensional Chromatic Fields Set More...

Inheritance diagram for ChromaticFieldsSet:

Public Member Functions
	ChromaticFieldsSet ()
	Initializes a new empty instance of the ChromaticFieldsSet class. Required only for correct deserialization (where the actual data is subsequently filled via reflection).
	ChromaticFieldsSet (ChromaticFieldsSet chromaticFieldsSet)
	Copy constructor.
	ChromaticFieldsSet (DataArray2D datasets, List< double > wavelengths, ChromaticFieldsSetType typeOfChromaticFieldsSet=ChromaticFieldsSetType.Unspecified, bool spectrumIsDiscrete=true)
	standard constructor
override object	Clone ()
	Deep copy.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance.
override FormDocument	GetNewDocumentWindow (Form formMain, string fileName)
override DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this.
override string	ToString ()
	overridden to string method of the chromatic fields set class
Public Member Functions inherited from ChromaticFieldsSetBase
	ChromaticFieldsSetBase (ChromaticFieldsSetBase chromaticFieldsSet)
	Copy constructor.
	ChromaticFieldsSetBase (List< double > wavelengths, ChromaticFieldsSetType typeOfChromaticFieldsSet, bool spectrumIsDiscrete)
	standard constructor
override object	Clone ()
	Clones the current object.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance.
DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this.
override string	ToString ()
	overridden to string method of the chromatic fields set class

Static Public Member Functions
static ChromaticFieldsSet	Load (string fileName)
	Loads the specified file name. Works independently from whether the document has been saved without view settings (as prior to VL 6.0) or with view settings.

Properties
virtual DataArray2D	Stored2DDataSets [get]
	public get property for the internal stored DataArray2D
override DataArrayBase	StoredDataSets [get]
	The underlying data as DataArrayBase.
Properties inherited from ChromaticFieldsSetBase
override string	FileExtension [get]
	Extension for saved files.
bool	IsDiscreteSpectrum [get, set]
	public property to get and set whether spectrum (stored in CFS) shall be interpreted discrete [true] or continuously [false]
bool	IsOneD [get]
	abstract property to get whether the chromatic fields set is 1D, or 2D
string	PhysicalObjectDescriptionForView [get]
	public property to get the description string for the physical object information in the chromatic fields set view
DataArrayBase	StoredDataSets [get]
	The underlying data as DataArrayBase.
ChromaticFieldsSetType	TypeOfChromaticFieldsSet [get, set]
	Gets or sets what type of chromatic fields set.
override DocumentType	TypeOfDocument [get]
	The type of the document.
List< double >	Wavelengths [get, set]
	Gets and sets the wavelength list of the ChromaticFieldsSet.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a two-dimensional Chromatic Fields Set

Constructor & Destructor Documentation

ChromaticFieldsSet() [1/2]

ChromaticFieldsSet	(	DataArray2D	datasets,
		List< double >	wavelengths,
		ChromaticFieldsSetType	typeOfChromaticFieldsSet = ChromaticFieldsSetType::Unspecified,
		bool	spectrumIsDiscrete = true
	)

standard constructor

Parameters

datasets	the dataset which shall be stores within the ChromaticFieldsSet
wavelengths	the list of wavelength which shall be stores within the ChromaticFieldsSet
typeOfChromaticFieldsSet	additional information of the type of the chromatic fields set
spectrumIsDiscrete	additional information to define whether the wavelengths information within the chromatic fields set shall be interpreted discrete or continuous

Exceptions

NotEquidistantException
ArgumentException	Chromatic Fields Sets that shall represent intensities may not contain complex or negative values.

ChromaticFieldsSet() [2/2]

ChromaticFieldsSet

(

ChromaticFieldsSet

chromaticFieldsSet

)

Copy constructor.

Parameters

chromaticFieldsSet

ChromaticFieldsSet to copy

Member Function Documentation

Clone()

override object Clone

(

)

Deep copy.

Returns

Deep copy of this

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.

GetSumOfAllSubsets()

override DataArrayBase GetSumOfAllSubsets

(

)

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

Returns

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

Load()

static ChromaticFieldsSet Load ( string  fileName )

static

Loads the specified file name. Works independently from whether the document has been saved without view settings (as prior to VL 6.0) or with view settings.

Parameters

fileName

Name of the file.

Returns

The specified document.

ToString()

override string ToString

(

)

overridden to string method of the chromatic fields set class

Returns

the string description of the chromatic fields set class