DataArrayGridLess Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for objects that store data in C^N which are arbitrarily distributed (i.e. not on a grid) in R^M More...

Inheritance diagram for DataArrayGridLess:

Public Member Functions
override object	Clone ()
	Deep copy More...
PhysicalValue[]	CoordinatesByDataPointIndex (long index)
	Gets the coordinates for a given list index More...
	DataArrayGridLess (ComplexField coordinates, PhysicalProperty[] propertiesOfCoordinates, string[] commentsOfCoordinates, ComplexField1DArray data, PhysicalProperty[] propertiesOfdata, string[] commentsOfdata)
	Constructor that uses arrays of coordinates and data values More...
	DataArrayGridLess (ComplexField coordinates, PhysicalProperty[] propertiesOfCoordinates, string[] commentsOfCoordinates, ComplexField1DArray data, PhysicalProperty[] propertiesOfdata, string[] commentsOfdata, ComplexField meshInformation)
	Constructor that uses arrays of coordinates and data values More...
	DataArrayGridLess (DataArrayGridLess dataArray)
	Copy constructor More...
	DataArrayGridLess (List< VectorD > coordinates,(PhysicalProperty propX, PhysicalProperty propY) propertiesOfCoordinates,(string descriptionX, string descriptionY) commentsOfCoordinates, ComplexField1DArray data, PhysicalProperty[] propertiesOfdata, string[] commentsOfdata)
	Special constructor for 2D gridless data arrays. More...
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. More...
DataArray1D	Extract1DDataAlongLine (Line_forGUI_physicalUnits extractionLine, double relativeEpsilon, double startCoordinate, out string errorMessage, out bool invertedOrder)
	Method which extracts a non-equidistant 1D data array along a given line. More...
List< int >[,]	FindGrid2D (out double[] xCellsCoords, out double[] yCellsCoords)
	Finds a 2D grid for gridless 2D data. Two data points get into the same cell only if NumericalChecks.AreEqual(..) gives TRUE for the coordinates of these data points. More...
virtual PhysicalValueRange	GetCoordinateRangeForDimension (int dimension)
	support method to get the coordinate range for a specific dimension the user need to specify the dimension which shall be evaluated More...
void	GetCoordinatesAndDataValueByDataPointIndex (long index, out PhysicalValue[] coordinates, out PhysicalValueComplex[] value)
	Gets the pair of coordinate vector and data value vector for a given list index More...
void	GetMinMaxRangeForValues (int indexSubsetToCheck, FieldQuantity quantityToCheck, bool evaluateForTriangles, out double minValue, out double maxValue)
	public support method to get the min max value range for the selected values within the data array More...
override void	Save (string fileName)
	Save this data array to a file with a given name. More...
void	SetDataWithPropertiesAndCommentsAtOnce (ComplexField1DArray data, PhysicalProperty[] properties, string[] comments)
	Sets the members Data, PhysicalPropertiesOfDataEntries and CommentsOfDataEntries at once to ensure consistency. More...
Public Member Functions inherited from DataArrayBase
	DataArrayBase ()
	Standard constructor used for manual serialization
	DataArrayBase (DataArrayBase copyDA)
	copy constructor More...
Public Member Functions inherited from IDocument
void	Reload ()
	Reload function for the document

Static Public Member Functions
static DataArrayGridLess	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
string[]	CommentsOfCoordinates [get, set]
	Get and set the comment for each dimension in R^M.
override string[]	CommentsOfDataEntries [get, set]
	Get and set the comment for each dimension in C^N.
ComplexField	Coordinates [get, set]
	Get and set the coordinates for the data in R^M. The coordinates for each dimension k (zero based!) are stored in the columns of this ComplexField: [k, *].
ComplexField1DArray	Data [get, set]
	Get and set the data in C^N. Each 1D complexField holds the data for one dimension.
override DataArrayType	DataArrayType [get]
	// The graphics add-on data to be drawn. // More...
string	DescriptionOfDataPointLabels [get, set]
	Gets and sets the caption of the index / label column. More...
override int	DimensionalityOfCoordinates [get]
	Dimensionality M of the space of independent variables R^M
override int	DimensionalityOfData [get]
	Dimensionality N of the space of data values C^N
override bool	IsComplex [get]
	Are the values defined in C^N (TRUE) or in the subset of real numbers R^N (FALSE)
ComplexField	MeshInformation [get, set]
	public property to set and get the mesh information of the DataArrayGridLess If no mesh information is given null will be returned. The ComplexField holds the point indices for each triangle's vertices. So [0,i], [1,i], [2,i] hold the indices of the points which represent the vertices of the i'th triangle.
bool	MeshInformationAvailable [get]
	public support function which can be used to evaluate whether mesh information is available
long	NoOfDataPoints [get]
	Get the number of data values stored.
override bool	NoSmoothingInterpolationMethod [get]
	Gets a flag indicating whether or not none of the interpolation methods is smoothing (like nearest neighbor or constant interval) -> TRUE But if one of the methods does (like all other methods) -> the flag is set to FALSE
PhysicalProperty[]	PhysicalPropertiesOfCoordinates [get, set]
	Get and set the physical property for each dimension in R^M
override PhysicalProperty[]	PhysicalPropertiesOfDataEntries [get, set]
	Get and set the physical property for each dimension in C^N
override PrecisionMode	Precision [get]
	Get the highest occurring precision of the data.
Properties inherited from DataArrayBase
Dictionary< string, object >	AdditionalInformation [get, set]
	Additional information to be stored at the data array.
abstract string[]	CommentsOfDataEntries [get, set]
	Get and set the comment for each dimension in C^N.
abstract int	DimensionalityOfCoordinates [get]
	Dimensionality M of the space of independent variables R^M
abstract int	DimensionalityOfData [get]
	Dimensionality N of the space of data values C^N
UI.DataVisualization.GraphicsAddOnData	GraphicsAddons [get, set]
	The graphics add-on data to be drawn.
abstract bool	IsComplex [get]
	Are the values defined in C^N (TRUE) or in the subset of real numbers R^N (FALSE)
abstract bool	NoSmoothingInterpolationMethod [get]
	Gets a flag indicating whether or not none of the interpolation methods is smoothing (like nearest neighbor or constant interval) -> TRUE But if one of the methods does (like all other methods) -> the flag is set to FALSE
PhysicalMeaning	PhysicalMeaning [get, set]
	Gets and sets the physical meaning of the data array object (default: None)
abstract PhysicalProperty[]	PhysicalPropertiesOfDataEntries [get, set]
	Get and set the physical property for each dimension in C^N
abstract PrecisionMode	Precision [get]
	Get the highest occurring precision of the data.
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.

Additional Inherited Members
Static Public Attributes inherited from DataArrayBase
static string	AdditionalInfoName_SingleWavelength
	Key to be used in the additional information list in order to identify a single wavelength which applies to all subsets.
static string	AdditionalInfoName_SphericalModulationFlag
	Key to be used in the additional information list in order to identify the flag which tells whether or not the modulation of a EquidistantDataBased2DFieldGenerator is defined in spherical coordinates.
static string	AdditionalInfoName_WavelengthPerSubset
	Key to be used in the additional information list in order to identify an array of wavelengths where every value applies to one subset.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for objects that store data in C^N which are arbitrarily distributed (i.e. not on a grid) in R^M

Constructor & Destructor Documentation

DataArrayGridLess() [1/4]

DataArrayGridLess	(	ComplexField	coordinates,
		PhysicalProperty[]	propertiesOfCoordinates,
		string[]	commentsOfCoordinates,
		ComplexField1DArray	data,
		PhysicalProperty[]	propertiesOfdata,
		string[]	commentsOfdata
	)

Constructor that uses arrays of coordinates and data values

Parameters

coordinates	Array of coordinates in R^M
propertiesOfCoordinates	Physical property for the coordinates
commentsOfCoordinates	Comment for the coordinates
data	Array of data in C^N
propertiesOfdata	Physical properties of each data subset.
commentsOfdata	Comments for each data subset.

DataArrayGridLess() [2/4]

DataArrayGridLess	(	List< VectorD >	coordinates,
		(PhysicalProperty propX, PhysicalProperty propY)	propertiesOfCoordinates,
		(string descriptionX, string descriptionY)	commentsOfCoordinates,
		ComplexField1DArray	data,
		PhysicalProperty[]	propertiesOfdata,
		string[]	commentsOfdata
	)

Special constructor for 2D gridless data arrays.

Parameters

coordinates

"D coordinates.</param> <param name="propertiesOfCoordinates">Physical property for the coordinates</param> <param name="commentsOfCoordinates">Descriptions for the coordinates</param> <param name="data">Array of data in C^N</param> <param name="propertiesOfdata">Physical properties of each data subset.</param> <param name="commentsOfdata">Comments for each data subset.

DataArrayGridLess() [3/4]

DataArrayGridLess	(	ComplexField	coordinates,
		PhysicalProperty[]	propertiesOfCoordinates,
		string[]	commentsOfCoordinates,
		ComplexField1DArray	data,
		PhysicalProperty[]	propertiesOfdata,
		string[]	commentsOfdata,
		ComplexField	meshInformation
	)

Constructor that uses arrays of coordinates and data values

Parameters

coordinates	Array of coordinates in R^2
propertiesOfCoordinates	Physical property for the coordinates
commentsOfCoordinates	Comment for the coordinates
data	Array of data in C^N
propertiesOfdata	Physical properties of each data subset.
commentsOfdata	Comments for each data subset.
meshInformation	the mesh information used within the object

DataArrayGridLess() [4/4]

DataArrayGridLess

(

DataArrayGridLess

dataArray

)

Copy constructor

Parameters

dataArray

Member Function Documentation

Clone()

override object Clone

(

)

Deep copy

Returns

Copy of data array

CoordinatesByDataPointIndex()

PhysicalValue[] CoordinatesByDataPointIndex

(

long

index

)

Gets the coordinates for a given list index

Parameters

index

Index to get the located data for

Returns

Coordinate vector for the index

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.

Extract1DDataAlongLine()

DataArray1D Extract1DDataAlongLine	(	Line_forGUI_physicalUnits	extractionLine,
		double	relativeEpsilon,
		double	startCoordinate,
		out string	errorMessage,
		out bool	invertedOrder
	)

Method which extracts a non-equidistant 1D data array along a given line.

Parameters

extractionLine	Line to extract along.
relativeEpsilon	Epsilon for identifying coordinates as lying "on" the line.
errorMessage	Error message string.
startCoordinate	The coordinate the 1D data array shall start with.
invertedOrder	If true, the order of the points in the data array is inverted to the order of the points on the line selection.

Returns

1D data along the given line.

FindGrid2D()

List< int >[,] FindGrid2D	(	out double[]	xCellsCoords,
		out double[]	yCellsCoords
	)

Finds a 2D grid for gridless 2D data. Two data points get into the same cell only if NumericalChecks.AreEqual(..) gives TRUE for the coordinates of these data points.

Parameters

xCellsCoords	sorted array of unique x coordinates for all grid cells
yCellsCoords	sorted array of unique y coordinates for all grid cells

Returns

An 2D array of int lists, where the not empty cells hold a list of indices. These indices refer to the indices the data got in this DataArrayGridLess object.

GetCoordinateRangeForDimension()

virtual PhysicalValueRange GetCoordinateRangeForDimension ( int  dimension )

virtual

support method to get the coordinate range for a specific dimension the user need to specify the dimension which shall be evaluated

Parameters

dimension

The dimension to investigate. Important: It is zero-based.

Returns

the min/max value range

GetCoordinatesAndDataValueByDataPointIndex()

void GetCoordinatesAndDataValueByDataPointIndex	(	long	index,
		out PhysicalValue[]	coordinates,
		out PhysicalValueComplex[]	value
	)

Gets the pair of coordinate vector and data value vector for a given list index

Parameters

index	Index to get the located data for
coordinates	Coordinate vector for the index
value	Value vector for the index

GetMinMaxRangeForValues()

void GetMinMaxRangeForValues	(	int	indexSubsetToCheck,
		FieldQuantity	quantityToCheck,
		bool	evaluateForTriangles,
		out double	minValue,
		out double	maxValue
	)

public support method to get the min max value range for the selected values within the data array

Parameters

indexSubsetToCheck	the subset index which shall be evaluated
quantityToCheck	the field quantity to evaluate
evaluateForTriangles	flag whether to evaluate for triangles
minValue	out parameter for minimum value
maxValue	out parameter for maximum value

Load()

static DataArrayGridLess 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.

Save()

override void Save

(

string

fileName

)

Save this data array to a file with a given name.

Parameters

fileName

Name to save this data array to.

SetDataWithPropertiesAndCommentsAtOnce()

void SetDataWithPropertiesAndCommentsAtOnce	(	ComplexField1DArray	data,
		PhysicalProperty[]	properties,
		string[]	comments
	)

Sets the members Data, PhysicalPropertiesOfDataEntries and CommentsOfDataEntries at once to ensure consistency.

Parameters

data	Data to set.
properties	PhysicalPropertiesOfDataEntries to set.
comments	CommentsOfDataEntries to set.

Property Documentation

DataArrayType

override DataArrayType DataArrayType

get

// The graphics add-on data to be drawn. //

public property to get the data array type of the current data array

DescriptionOfDataPointLabels

string DescriptionOfDataPointLabels

getset

Gets and sets the caption of the index / label column.