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 (ChromaticFieldsSet chromaticFieldsSet)
	Copy constructor More...
	ChromaticFieldsSet (DataArray2D datasets, List< double > wavelengths)
	standard constructor More...
	ChromaticFieldsSet (DataArray2D datasets, List< double > wavelengths, ChromaticFieldsSetType type)
	Constructor to keep old Programmable Detectors working. More...
override object	Clone ()
	Deep copy More...
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. More...
override DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this More...
override string	ToString ()
	overridden to string method of the chromatic fields set class More...
Public Member Functions inherited from ChromaticFieldsSetBase
	ChromaticFieldsSetBase (ChromaticFieldsSetBase chromaticFieldsSet)
	Copy constructor More...
	ChromaticFieldsSetBase (List< double > wavelengths)
	standard constructor More...
override object	Clone ()
	Clones the current object. More...
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. More...
abstract DataArrayBase	GetSumOfAllSubsets ()
	Calculates a DataArray with a single subset containing the sum of all subsets of this More...
void	Reload ()
	Reload method for this document
void	Save (string fileName)
	Save method More...
override string	ToString ()
	overridden to string method of the chromatic fields set class More...
void	Reload ()
	Reload function for the document

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. More...

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
string	FileExtension [get]
	Extension for saved files
bool	IsOneD [get]
	abstract property to get whether the chromatic fields set is 1D, or 2D
VirtualLabSession	Session [get, set]
	public property to set and get the session where the document belongs to
abstract DataArrayBase	StoredDataSets [get]
	The underlying data as DataArrayBase.
NodeVLExplorer	TreeStructure [get]
	property to get the node structure for the VirtualLab Explorer
virtual ChromaticFieldsSetType	TypeOfChromaticFieldsSet [get]
	Gets or sets what type of chromatic fields set this is
DocumentType	TypeOfDocument [get]
	The type of the document.
List< double >	Wavelengths [get, set]
	Gets and sets the wavelength list of the ChromaticFieldsSet More...
Properties inherited from IDocument
VirtualLabSession	Session [get, set]
	every documents need to be handled in a session ==> default is the VirtualLab Mainsession
NodeVLExplorer	TreeStructure [get]
	every document should have a node (maybe with subnodes) in the VirtualLab Explorer
DocumentType	TypeOfDocument [get]
	Gets an enum entry specifying the type of the document.

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/3]

ChromaticFieldsSet	(	DataArray2D	datasets,
		List< double >	wavelengths
	)

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

Exceptions

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

ChromaticFieldsSet() [2/3]

ChromaticFieldsSet	(	DataArray2D	datasets,
		List< double >	wavelengths,
		ChromaticFieldsSetType	type
	)

Constructor to keep old Programmable Detectors working.

Parameters

datasets	the dataset which shall be stores within the ChromaticFieldsSet
wavelengths	the list of wavelength which shall be stores within the ChromaticFieldsSet
type	Optional, currently unused type of the Chromatic Fields Set.

Exceptions

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

ChromaticFieldsSet() [3/3]

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 ( )

virtual

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

Implements ChromaticFieldsSetBase.

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