This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Support class containing the manipulations for numerical data arrays. More...

Static Public Member Functions
static DataArrayBase	AddConstant_Complex (DataArrayBase dataArray, Complex constant, int[] subsetIndices)
	Add a constant to certain subsets. The operation will be a complex addition. More...

static DataArrayBase	AddConstant_Separately (DataArrayBase dataArray, double realPartOrAmplitude, double imaginaryPartOrPhase, bool amplitudePhaseRepresentation, int[] subsetIndices)
	Add a constant to certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively. More...

static DataArrayBase	AppendSubsetsFromAnotherDataArray (DataArrayBase targetDataArrayBase, DataArrayBase sourceDataArrayBase, int[] indicesToAppend, out string warnings)
	Method that appends the subsets of one data array to another. The data arrays have to have the same number of sampling points (for 2D: in each direction). More...

static DataArray1D	AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates (DataArray1D targetDataArray1D, DataArray1D sourceDataArray1D, int[] indicesToAppend, out string warnings)
	Method that appends subsets from a source data array to another one (the target data array). The source will be interpolated to the coordinates of the target. More...

static DataArray2D	AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates (DataArray2D targetDataArray2D, DataArray2D sourceDataArray2D, int[] indicesToAppend, out string warnings)
	Method that appends subsets from a source data array to another one (the target data array). The source will be interpolated to the coordinates of the target. More...

static DataArray1D	AppendSubsetsFromAnotherDataArrayWithMerging (DataArray1D targetDataArray1D, DataArray1D sourceDataArray1D, int[] indicesToAppend, out string warnings)
	Method that appends subsets from a source data array to another one (the target data array). The result will have merged coordinates. More...

static DataArray2D	AppendSubsetsFromAnotherDataArrayWithMerging (DataArray2D targetDataArray2D, DataArray2D sourceDataArray2D, int[] indicesToAppend, out string warnings)
	Method that appends subsets from a source data array to another one (the target data array). The result will have merged coordinates. More...

static DataArrayBase	AppendSubsetsFromAnotherDataArrayWithMerging (DataArrayBase targetDataArrayBase, DataArrayBase sourceDataArrayBase, int[] indicesToAppend, out string warnings)
	Method that appends the subsets of one data array to another. The data arrays have to have the same number of sampling points (for 2D: in each direction). More...

static DataArrayBase	ArrayArrayOperation (ArrayArrayOperationType operationType, DataArrayBase da1, DataArrayBase da2, List< Tuple< int, int > > indicesOfOperandSubsets, out string warnings)
	Does an array-array-operation of two data arrays. More...

static void	ChangeInterpolationMethodEquidistant (ref DataArrayBase dataArrayBase, InterpolationMethod interpolationMethod)
	Method to change the interpolation method of a data array. More...

static bool	CheckForIdenticalCoordinateParametersOfTwoDataArrays (DataArrayBase da1, DataArrayBase da2, bool checkNonSamplingParameters, out string warnings, out List<(string propName, string prop_1, string prop_2, bool samplingRelated)> differences, bool checkWithTolerance=true)
	Method that compares the coordinate and interpolation parameters of two given data arrays More...

static DataArrayBase	ClipValues (DataArrayBase dataArray, double amplitudeThreshold, int[] subsetIndices)
	Clips the amplitude (or real part for real valued data) at a given threshold. More...

static DataArrayBase	ConjugatePhase (DataArrayBase dataArray, int[] subsetIndices)
	Conjugates the phase. More...

static DataArray1D	Convolution (DataArray1D da1, DataArray1D da2, List< Tuple< int, int > > indicesOfOperandSubsets, out string warnings)
	Does a convolution of two data arrays. More...

static DataArray2D	Convolution (DataArray2D da1, DataArray2D da2, List< Tuple< int, int > > indicesOfOperandSubsets, out string warnings)
	Does a convolution of two data arrays. More...

static DataArray2D	CreatePointCloudAddOn (DataArray2D dataArray2receivePointCloud, DataArrayGridLess dataArrayGridLessWithPointCloud, int[] selectedSubsetIndices, out int noOfOutlyingPoints)
	Creates a point cloud add-on from a DataArrayGridLess and adds it to a given gridded 2D data array. More...

static DataArray2D	CreatePointCloudAddOn (DataArray2D dataArray2receivePointCloud, Propagation.RayDistribution rayDistribution, int[] selectedSubsetIndices, out int noOfOutlyingPoints)
	Creates a point cloud add-on from a RayDistribution and adds it to a given gridded 2D data array. More...

static DataArrayGridLess	CreatePointCloudAddOn (DataArrayGridLess dataArray2receivePointCloud, DataArrayGridLess dataArrayGridLessWithPointCloud, int[] selectedSubsetIndices, out int noOfOutlyingPoints)
	Creates a point cloud add-on from a DataArrayGridLess and adds it to a given gridless 2D data array. More...

static DataArrayGridLess	CreatePointCloudAddOn (DataArrayGridLess dataArray2receivePointCloud, Propagation.RayDistribution rayDistribution, int[] selectedSubsetIndices, out int noOfOutlyingPoints)
	Creates a point cloud add-on from a RayDistribution and adds it to a given gridless 2D data array. More...

static DataArray1D	CreateRegionAddOn (DataArray1D dataArray2receiveRegion, Numerics.Region1D.IntervalRegion region, int[] selectedSubsetIndices, out bool notCompletelyInDomain)
	Creates a region add-on from an interval region and adds it to a given 1D data array. More...

static DataArray2D	CreateRegionAddOn (DataArray2D dataArray2receiveRegion, Numerics.Region2D.ElementaryRegion2D region, int[] selectedSubsetIndices, out bool notCompletelyInDomain)
	Creates a region add-on from an elementary region and adds it to a given gridded 2D data array. More...

static DataArrayGridLess	CreateRegionAddOn (DataArrayGridLess dataArray2receiveRegion, Numerics.Region2D.ElementaryRegion2D region, int[] selectedSubsetIndices, out bool notCompletelyInDomain)
	Creates a region add-on from an elementary region and adds it to a given gridless 2D data array. More...

static DataArrayBase	DiscreteOversampling (DataArrayBase dataArray, int factor)
	Method for oversampling an equidistant data array in way that new sampling points are set to zero. More...

static DataArrayBase	DivideByConstant_Complex (DataArrayBase dataArray, Complex constant, int[] subsetIndices)
	Divide certain subsets by a constant. The operation will be a complex division. More...

static DataArrayBase	DivideByConstant_Separately (DataArrayBase dataArray, double realPartOrAmplitude, double imaginaryPartOrPhase, bool amplitudePhaseRepresentation, int[] subsetIndices)
	Divide certain subsets by a constant. The operation will consist of two independent real valued operations for the complex parts respectively. More...

static DataArrayBase	DoFieldQuantityOperationOnDataArray (DataArrayBase dataArrayBase, ComplexPart operation)
	Method that does a field quantity operation on a data array More...

static DataArrayBase	EquidistantResamplingOfDataArray (DataArrayBase dataArrayBase, Vector samplingPoints, VectorD samplingDistance, InterpolationMethod interpolationMethod, bool keepInterpolationMethodsUnchanged)
	Method to resample a data array. More...

static DataArray1D	ExtractEquidistant1DDataArrayFrom2DDataArray (DataArray2D dataArray2D, VectorD startPoint, VectorD endPoint, bool enforceSteppedInterpolation, int noOfPointsToExtract, double newStartCoordinate, string commentOfCoordinates, PhysicalProperty physicalPropertyOfCoordinate)
	Method for extracting an equidistantly sampled 1D data array from any 2D data array. This will be done along a line which has to be specified. More...

static DataArray1D	ExtractRangeSelection (DataArray1D inputDataArray, RectangleOfPixels rangeMarker, double rangeEndPoint)
	Extracts the given range of a one-dimensional data array. More...

static DataArray2D	ExtractRectangularSelection (DataArray2D inputDataArray, RectangleOfPixels rectangleMarker, VectorD rectEndPoint)
	Extracts the selected rectangular region of a two-dimensional data array. More...

static DataArray1D	ExtractSubsetDataAtOnePoint (DataArray1D dataArray1D, double extractionCoordinate, bool enforceSteppedInterpolation, string newCommentOfData, double newStartCoordinate, double newSamplingDistance, string commentOfNewCoordinate, PhysicalProperty physicalPropertyOfNewCoordinate, out PhysicalValueComplex singleValueForSingleSubset)
	Extracts the subset data at one point. More...

static DataArray1D	ExtractSubsetDataAtOnePoint (DataArray2D dataArray2D, VectorD extractionCoordinates, bool enforceSteppedInterpolation, string newCommentOfData, double newStartCoordinate, double newSamplingDistance, string commentOfNewCoordinate, PhysicalProperty physicalPropertyOfNewCoordinate, out PhysicalValueComplex singleValueForSingleSubset)
	Extracts the subset data at one point. More...

static ChromaticFieldsSetBase	ExtractSubsetsFromDataArray (ChromaticFieldsSetBase cfsBase, int[] indicesToBeKept)
	Method that extracts subsets from a data array More...

static DataArrayBase	ExtractSubsetsFromDataArray (DataArrayBase dataArrayBase, int[] indicesToBeKept)
	Method that extracts subsets from a data array More...

static DataArrayBase	FillSelection (DataArrayBase dataArray, Complex fillValue, RectangleOfPixels regionMarker, bool useInverseSelection, int[] subsetIndices)
	Fills the selected region of the data array with the specified value. More...

static DataArrayBase	FourierTransformationOfDataArray (DataArrayBase dataArray, bool useNumericalFT, bool useInverseFT)
	Applies a FFT to a data array. More...

static void	GetDifferentCoordinateParametersOfTwoDataArrays (DataArray1D dataArray_1, DataArray1D dataArray_2, bool checkWithTolerance, out List<(string propName, string prop_1, string prop_2, bool samplingRelated)> differences)
	Gets all data array differences related to the coordinates. More...

static void	GetDifferentCoordinateParametersOfTwoDataArrays (DataArray2D dataArray_1, DataArray2D dataArray_2, bool checkWithTolerance, out List<(string propName, string prop_1, string prop_2, bool samplingRelated)> differences_X, out List<(string propName, string prop_1, string prop_2, bool samplingRelated)> differences_Y)
	Gets all data array differences related to the coordinates. More...

static void	GetDifferentCoordinateParametersOfTwoDataArrays (DataArrayGridLess dataArray_1, DataArrayGridLess dataArray_2, bool checkWithTolerance, out List<(string propName, string prop_1, string prop_2, bool samplingRelated)> differences)
	Gets all data array differences related to the coordinates. More...

static DataArrayBase	GetTemporalSamplingOfRealPart (DataArrayBase numericalDataArray, int numberOfFrames, bool treatAsElectricField)
	Get temporal sampling of real part of first data subset over one period. The real part of the given data array is multiplied with exp(iomegat) [=exp(i2PI[t/T])]. More...

static DataArrayBase	LiftPositive (DataArrayBase dataArray, int[] subsetIndices)
	Lifts the values of a data array in a way no negative values occur in the real part anymore. More...

static DataArray1D	MirrorDataArray1D_Horizontally (DataArray1D dataArray, int[] subsetIndices)
	Method which performs a horizontal mirror operation on a DataArray1D. More...

static DataArray2D	MirrorDataArray2D_Horizontally (DataArray2D dataArray, int[] subsetIndices)
	Method which performs a horizontal mirror operation on a DataArray2D. More...

static DataArray2D	MirrorDataArray2D_Vertically (DataArray2D dataArray, int[] subsetIndices)
	Method which performs a vertical mirror operation on a DataArray2D. More...

static DataArrayBase	ModifyPhase (DataArrayBase dataArrayBase, PhaseModifyOperation operation, double wavelength, bool useQuantization, int numberOfLevels, double doubleParameter, bool hermitian, bool superimpose, int[] subsetIndices)
	Static method which modifies the phase in various ways. More...

static DataArrayBase	MultiplyConstant_Complex (DataArrayBase dataArray, Complex constant, int[] subsetIndices)
	Multiply a constant with certain subsets. The operation will be a complex multiplication. More...

static DataArrayBase	MultiplyConstant_Separately (DataArrayBase dataArray, double realPartOrAmplitude, double imaginaryPartOrPhase, bool amplitudePhaseRepresentation, int[] subsetIndices)
	Multiply a constant with certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively. More...

static DataArrayBase	Normalize (DataArrayBase dataArray, RectangleOfPixels regionMarker=null, int[] subsetIndices)
	Normalizes a data array, i.e. brings the amplitude into the range 0 ... +1 and the real part into the range -1 ... +1. More...

static DataArrayBase	PeriodicReplicationOfDataArray (DataArrayBase dataArrayBase, VectorD replicationFactors, bool keepOriginalInCenter)
	Method for periodic replication of data arrays. More...

static DataArrayBase	Quantize (DataArrayBase dataArray, QuantizationType quantizationType, int noOfAmplitudeLevels, int noOfPhaseLevels, double softQuantizationFactor)
	Does a quantization of all subsets of a data array. More...

static DataArrayBase	RaiseToPowerOfConstant_Complex (DataArrayBase dataArray, Complex constant, int[] subsetIndices)
	Raise to the power of a constant with certain subsets. The operation will be a complex exponentiation. More...

static DataArrayBase	RaiseToPowerOfConstant_Separately (DataArrayBase dataArray, double realPartOrAmplitude, double imaginaryPartOrPhase, bool amplitudePhaseRepresentation, int[] subsetIndices)
	Raise to the power of a constant with certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively. More...

static DataArray2D	RemovePhaseDislocationsInsideSelection (DataArray2D dataArray, RectangleOfPixels regionMarker, int[] subsetIndices)
	Static function to remove all phase dislocations within the rectangular selection. More...

static DataArray2D	RemoveRedundantData (DataArray2D inputDataArray)
	Removes redundant data in a two-dimensional non-equidistant data array with Constant Interval interpolation and one subset. First all columns are scanned whether two consecutive columns have the same data. Then the same is done for all rows. More...

static ChromaticFieldsSetBase	RemoveSubsetsFromDataArray (ChromaticFieldsSetBase cfsBase, int[] removeIndices)
	Method that removes subsets from a data array More...

static DataArrayBase	RemoveSubsetsFromDataArray (DataArrayBase dataArrayBase, int[] removeIndices)
	Method that removes subsets from a data array More...

static DataArrayBase	SavitzkyGolayFilter (DataArrayBase dataArray, int windowSize, int order)
	Applies the Savitzky-Golay-Filter on the given data array. This filter is a special low-pass filter, well adapted for data smoothing. More...

static DataArrayBase	ScaleToValueRange (DataArrayBase dataArray, double minimum, double maximum, bool cloneDataArray, int[] subsetIndices)
	Normalizes a data array, i.e. brings the amplitude into the range 0 ... +1 and the real part into the range -1 ... +1. More...

static DataArrayBase	SetToConstant (DataArrayBase dataArray, Complex constant, int[] subsetIndices)
	Set certain subsets to a constant. More...

static DataArrayBase	SumOfAllSubsets (DataArrayBase dataArrayBase, bool complexAddition, ComplexPart partToSumInComplexCase)
	Method which allows a complex-valued or real-valued summation of all subsets of a data array. More...

static DataArray2D	TransposeDataArray2D (DataArray2D dataArray)
	Method which transposes a DataArray2D, which swaps all x and y properties. More...

static DataArrayGridLess	TransposeDataArray2D (DataArrayGridLess dataArray)
	Method which transposes a DataArrayGridLess, which swaps all x and y properties. More...

static DataArrayBase	UnwrapPhase (DataArrayBase dataArray, int[] subsetIndices)
	Unwraps the phase, i.e. removes the 2 \(\pi\) jumps. More...

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Support class containing the manipulations for numerical data arrays.

Member Function Documentation

◆ AddConstant_Complex()

static DataArrayBase AddConstant_Complex	(	DataArrayBase	dataArray,
		Complex	constant,
		int[]	subsetIndices
	)

static

Add a constant to certain subsets. The operation will be a complex addition.

Parameters

dataArray	The data array to manipulate.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.
constant	The complex constant to be used for the operation.

Returns: The result of the addition.

◆ AddConstant_Separately()

static DataArrayBase AddConstant_Separately	(	DataArrayBase	dataArray,
		double	realPartOrAmplitude,
		double	imaginaryPartOrPhase,
		bool	amplitudePhaseRepresentation,
		int[]	subsetIndices
	)

static

Add a constant to certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively.

Parameters

dataArray	The data array to manipulate.
realPartOrAmplitude	The value added to the real part or the amplitude.
imaginaryPartOrPhase	The value added to the imaginary part or the phase.
amplitudePhaseRepresentation	If set to `true` amplitude and phase are given. Otherwise real and imaginary part are given.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the addition.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ AppendSubsetsFromAnotherDataArray()

static DataArrayBase AppendSubsetsFromAnotherDataArray	(	DataArrayBase	targetDataArrayBase,
		DataArrayBase	sourceDataArrayBase,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends the subsets of one data array to another. The data arrays have to have the same number of sampling points (for 2D: in each direction).

Parameters

targetDataArrayBase	Data array to append the subsets to
sourceDataArrayBase	Data array to get the subsets from.
indicesToAppend	The indices of the subsets to append.
warnings	Out parameter containing possible warnings.

Returns: A data array with copied subsets appended.

Exceptions

System.ArgumentException The data arrays have to be of the same type. or No valid index array given. or Method works for DataArray1D and DataArray2D only.

◆ AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates() [1/2]

static DataArray1D AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates	(	DataArray1D	targetDataArray1D,
		DataArray1D	sourceDataArray1D,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends subsets from a source data array to another one (the target data array). The source will be interpolated to the coordinates of the target.

Parameters

targetDataArray1D	The data array new subsets will be appended to.
sourceDataArray1D	The data array the subsets to be appended are get from.
indicesToAppend	The subset indices of the subsets from the source to be appended.
warnings	Warning which occurred if some parameters are not fitting.

Returns: A new data array with merged coordinates which holds all subsets of the target (which have been interpolated of the merged coordinates) as well as the selected subsets of the source (which have been interpolated too).

Exceptions

System.ArgumentException	No valid index array given.
System.IndexOutOfRangeException	Invalid subset index found.

◆ AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates() [2/2]

static DataArray2D AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates	(	DataArray2D	targetDataArray2D,
		DataArray2D	sourceDataArray2D,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends subsets from a source data array to another one (the target data array). The source will be interpolated to the coordinates of the target.

Parameters

targetDataArray2D	The data array new subsets will be appended to.
sourceDataArray2D	The data array the subsets to be appended are get from.
indicesToAppend	The subset indices of the subsets from the source to be appended.
warnings	Warning which occurred if some parameters are not fitting.

Returns: A new data array with merged coordinates which holds all subsets of the target (which have been interpolated of the merged coordinates) as well as the selected subsets of the source (which have been interpolated too).

Exceptions

System.ArgumentException	No valid index array given.
System.IndexOutOfRangeException	Invalid subset index found.

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [1/3]

static DataArray1D AppendSubsetsFromAnotherDataArrayWithMerging	(	DataArray1D	targetDataArray1D,
		DataArray1D	sourceDataArray1D,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends subsets from a source data array to another one (the target data array). The result will have merged coordinates.

Parameters

targetDataArray1D	The data array new subsets will be appended to.
sourceDataArray1D	The data array the subsets to be appended are get from.
indicesToAppend	The subset indices of the subsets from the source to be appended.
warnings	Warning which occurred if some parameters are not fitting.

Returns: A new data array with merged coordinates which holds all subsets of the target (which have been interpolated of the merged coordinates) as well as the selected subsets of the source (which have been interpolated too).

Exceptions

System.IndexOutOfRangeException Invalid subset index found.

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [2/3]

static DataArray2D AppendSubsetsFromAnotherDataArrayWithMerging	(	DataArray2D	targetDataArray2D,
		DataArray2D	sourceDataArray2D,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends subsets from a source data array to another one (the target data array). The result will have merged coordinates.

Parameters

targetDataArray2D	The data array new subsets will be appended to.
sourceDataArray2D	The data array the subsets to be appended are get from.
indicesToAppend	The subset indices of the subsets from the source to be appended. If this array is null or empty, all subsets of the source array will be appended.
warnings	Warning which occurred if some parameters are not fitting.

Returns: A new data array with merged coordinates which holds all subsets of the target (which have been interpolated of the merged coordinates) as well as the selected subsets of the source (which have been interpolated too).

Exceptions

System.IndexOutOfRangeException Invalid subset index found.

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [3/3]

static DataArrayBase AppendSubsetsFromAnotherDataArrayWithMerging	(	DataArrayBase	targetDataArrayBase,
		DataArrayBase	sourceDataArrayBase,
		int[]	indicesToAppend,
		out string	warnings
	)

static

Method that appends the subsets of one data array to another. The data arrays have to have the same number of sampling points (for 2D: in each direction).

Parameters

targetDataArrayBase	Data array to append the subsets to
sourceDataArrayBase	Data array to get the subsets from.
indicesToAppend	The indices of the subsets to append.
warnings	Out parameter containing possible warnings.

Returns: A data array with copied subsets appended.

Exceptions

System.ArgumentException The data arrays have to be of the same type. or No valid index array given. or Method works for DataArray1D and DataArray2D only.

◆ ArrayArrayOperation()

static DataArrayBase ArrayArrayOperation	(	ArrayArrayOperationType	operationType,
		DataArrayBase	da1,
		DataArrayBase	da2,
		List< Tuple< int, int > >	indicesOfOperandSubsets,
		out string	warnings
	)

static

Does an array-array-operation of two data arrays.

Parameters

operationType	Type of operation to be done.
da1	First operand.
da2	Second operand.
indicesOfOperandSubsets	List of those index pairs which correspond to the subsets that have to be used for the subset operations.
warnings	Warnings in case the coordinate parameters don't match.

Returns: The result of the array-array-operation.

Exceptions

System.ArgumentException	The data arrays have to have identical coordinate dimensionalities. or operationType not supported. or Operation supports 1D and gridded 2D data arrays only.
System.IndexOutOfRangeException	Invalid subset index found.

◆ ChangeInterpolationMethodEquidistant()

static void ChangeInterpolationMethodEquidistant	(	ref DataArrayBase	dataArrayBase,
		InterpolationMethod	interpolationMethod
	)

static

Method to change the interpolation method of a data array.

Parameters

dataArrayBase	Reference to the data array whose interpolation method shall be changed.
interpolationMethod	Interpolation method that shall be used for resampling in both directions

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ CheckForIdenticalCoordinateParametersOfTwoDataArrays()

static bool CheckForIdenticalCoordinateParametersOfTwoDataArrays	(	DataArrayBase	da1,
		DataArrayBase	da2,
		bool	checkNonSamplingParameters,
		out string	warnings,
		out List<(string propName, string prop_1, string prop_2, bool samplingRelated)>	differences,
		bool	checkWithTolerance = `true`
	)

static

Method that compares the coordinate and interpolation parameters of two given data arrays

Parameters

da1	First data array to be compared with second.
da2	Second data array to be compared with first.
checkNonSamplingParameters	If TRUE, the return value will be 'false' even if only those properties which are not directly related to sampling (e.g. interpolation, physical meaning) are not equal. Otherwise, all sampling related parameters being equal will be sufficient for the return value to be 'true'.
warnings	String of warnings that result from differing parameters.

Returns: TRUE if the parameters are identical.

◆ ClipValues()

static DataArrayBase ClipValues	(	DataArrayBase	dataArray,
		double	amplitudeThreshold,
		int[]	subsetIndices
	)

static

Clips the amplitude (or real part for real valued data) at a given threshold.

Parameters

dataArray	The data array which shall be clipped.
amplitudeThreshold	The amplitude / real part threshold to clip at.
subsetIndices	One or more subset indices which shall be manipulated. If none is specified, then all subsets are manipulated.

Returns: The clipped data array.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ ConjugatePhase()

static DataArrayBase ConjugatePhase	(	DataArrayBase	dataArray,
		int[]	subsetIndices
	)

static

Conjugates the phase.

Parameters

dataArray	The data array whose phase shall be conjugated.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The data array with the conjugated phase.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ Convolution() [1/2]

static DataArray1D Convolution	(	DataArray1D	da1,
		DataArray1D	da2,
		List< Tuple< int, int > >	indicesOfOperandSubsets,
		out string	warnings
	)

static

Does a convolution of two data arrays.

Parameters

da1	First operand.
da2	Second operand.
indicesOfOperandSubsets	List of those index pairs which correspond to the subsets that have to be used for the subset operations.
warnings	Warnings in case the coordinate parameters don't match.

Returns: The result of the array-array-operation.

Exceptions

System.ArgumentException Operands have to be equidistant.

◆ Convolution() [2/2]

static DataArray2D Convolution	(	DataArray2D	da1,
		DataArray2D	da2,
		List< Tuple< int, int > >	indicesOfOperandSubsets,
		out string	warnings
	)

static

Does a convolution of two data arrays.

Parameters

da1	First operand.
da2	Second operand.
indicesOfOperandSubsets	List of those index pairs which correspond to the subsets that have to be used for the subset operations.
warnings	Warnings in case the coordinate parameters don't match.

Returns: The result of the array-array-operation.

Exceptions

System.ArgumentException Operands have to be completely equidistantly sampled.

◆ CreatePointCloudAddOn() [1/4]

static DataArray2D CreatePointCloudAddOn	(	DataArray2D	dataArray2receivePointCloud,
		DataArrayGridLess	dataArrayGridLessWithPointCloud,
		int[]	selectedSubsetIndices,
		out int	noOfOutlyingPoints
	)

static

Creates a point cloud add-on from a DataArrayGridLess and adds it to a given gridded 2D data array.

Parameters

dataArray2receivePointCloud	Data array to add the point cloud add-on.
dataArrayGridLessWithPointCloud	DataArrayGridLess to create the point cloud from.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
noOfOutlyingPoints	The number of that point cloud points which lie outside the domain of the gridded 2D DA.

◆ CreatePointCloudAddOn() [2/4]

static DataArray2D CreatePointCloudAddOn	(	DataArray2D	dataArray2receivePointCloud,
		Propagation.RayDistribution	rayDistribution,
		int[]	selectedSubsetIndices,
		out int	noOfOutlyingPoints
	)

static

Creates a point cloud add-on from a RayDistribution and adds it to a given gridded 2D data array.

Parameters

dataArray2receivePointCloud	Data array to add the point cloud add-on.
rayDistribution	Ray distribution to create the point cloud from.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
noOfOutlyingPoints	The number of that point cloud points which lie outside the domain of the gridded 2D DA.

◆ CreatePointCloudAddOn() [3/4]

static DataArrayGridLess CreatePointCloudAddOn	(	DataArrayGridLess	dataArray2receivePointCloud,
		DataArrayGridLess	dataArrayGridLessWithPointCloud,
		int[]	selectedSubsetIndices,
		out int	noOfOutlyingPoints
	)

static

Creates a point cloud add-on from a DataArrayGridLess and adds it to a given gridless 2D data array.

Parameters

dataArray2receivePointCloud	Data array to add the point cloud add-on.
dataArrayGridLessWithPointCloud	DataArrayGridLess to create the point cloud from.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
noOfOutlyingPoints	The number of that point cloud points which lie outside the domain of the gridded 2D DA.

◆ CreatePointCloudAddOn() [4/4]

static DataArrayGridLess CreatePointCloudAddOn	(	DataArrayGridLess	dataArray2receivePointCloud,
		Propagation.RayDistribution	rayDistribution,
		int[]	selectedSubsetIndices,
		out int	noOfOutlyingPoints
	)

static

Creates a point cloud add-on from a RayDistribution and adds it to a given gridless 2D data array.

Parameters

dataArray2receivePointCloud	Data array to add the point cloud add-on.
rayDistribution	Ray distribution to create the point cloud from.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
noOfOutlyingPoints	The number of that point cloud points which lie outside the domain of the gridded 2D DA.

◆ CreateRegionAddOn() [1/3]

static DataArray1D CreateRegionAddOn	(	DataArray1D	dataArray2receiveRegion,
		Numerics.Region1D.IntervalRegion	region,
		int[]	selectedSubsetIndices,
		out bool	notCompletelyInDomain
	)

static

Creates a region add-on from an interval region and adds it to a given 1D data array.

Parameters

dataArray2receiveRegion	Data array to add the region add-on.
region	Region to use as add-on.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
notCompletelyInDomain	If `true`, the given region may not lie completely inside the data arrays domain.

◆ CreateRegionAddOn() [2/3]

static DataArray2D CreateRegionAddOn	(	DataArray2D	dataArray2receiveRegion,
		Numerics.Region2D.ElementaryRegion2D	region,
		int[]	selectedSubsetIndices,
		out bool	notCompletelyInDomain
	)

static

Creates a region add-on from an elementary region and adds it to a given gridded 2D data array.

Parameters

dataArray2receiveRegion	Data array to add the region add-on.
region	Region to use as add-on.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
notCompletelyInDomain	If `true`, the given region may not lie completely inside the data arrays domain.

◆ CreateRegionAddOn() [3/3]

static DataArrayGridLess CreateRegionAddOn	(	DataArrayGridLess	dataArray2receiveRegion,
		Numerics.Region2D.ElementaryRegion2D	region,
		int[]	selectedSubsetIndices,
		out bool	notCompletelyInDomain
	)

static

Creates a region add-on from an elementary region and adds it to a given gridless 2D data array.

Parameters

dataArray2receiveRegion	Data array to add the region add-on.
region	Region to use as add-on.
selectedSubsetIndices	Array of subset indices to apply the point cloud on.
notCompletelyInDomain	If `true`, the given region may not lie completely inside the data arrays domain.

◆ DiscreteOversampling()

static DataArrayBase DiscreteOversampling	(	DataArrayBase	dataArray,
		int	factor
	)

static

Method for oversampling an equidistant data array in way that new sampling points are set to zero.

Parameters

dataArray	Data array to be oversampled.
factor	Oversampling factor.

Returns: The resampled data array.

Exceptions

System.ArgumentOutOfRangeException	The oversampling factor has to be greater or equal 1.
System.ArgumentException	The method works for equidistant arrays only. or Method works for DataArray1D and DataArray2D only.

◆ DivideByConstant_Complex()

static DataArrayBase DivideByConstant_Complex	(	DataArrayBase	dataArray,
		Complex	constant,
		int[]	subsetIndices
	)

static

Divide certain subsets by a constant. The operation will be a complex division.

Parameters

dataArray	The data array to manipulate.
constant	The complex constant to be used for the operation.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the division.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ DivideByConstant_Separately()

static DataArrayBase DivideByConstant_Separately	(	DataArrayBase	dataArray,
		double	realPartOrAmplitude,
		double	imaginaryPartOrPhase,
		bool	amplitudePhaseRepresentation,
		int[]	subsetIndices
	)

static

Divide certain subsets by a constant. The operation will consist of two independent real valued operations for the complex parts respectively.

Parameters

dataArray	The data array to manipulate.
realPartOrAmplitude	The value by which the real part or the amplitude is divided.
imaginaryPartOrPhase	The value by which the imaginary part or the phase is divided.
amplitudePhaseRepresentation	If set to `true` amplitude and phase are given. Otherwise real and imaginary part are given.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the division.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ DoFieldQuantityOperationOnDataArray()

static DataArrayBase DoFieldQuantityOperationOnDataArray	(	DataArrayBase	dataArrayBase,
		ComplexPart	operation
	)

static

Method that does a field quantity operation on a data array

Parameters

dataArrayBase	Data array to operate on
operation	Field quantity operation to do.

Returns: A data array that results from the given operation.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ EquidistantResamplingOfDataArray()

static DataArrayBase EquidistantResamplingOfDataArray	(	DataArrayBase	dataArrayBase,
		Vector	samplingPoints,
		VectorD	samplingDistance,
		InterpolationMethod	interpolationMethod,
		bool	keepInterpolationMethodsUnchanged
	)

static

Method to resample a data array.

Parameters

dataArrayBase	Data array to be resampled.
samplingPoints	New number of sampling points.
samplingDistance	New sampling distances.
interpolationMethod	Interpolation method that shall be used for resampling in both directions
keepInterpolationMethodsUnchanged	If TRUE, the interpolation methods for the data array are kept unchanged, no matter what methods have been used for resampling. If FALSE, the methods for resampling are set as the data array's new interpolation methods.

Returns: Resampled data array.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ ExtractEquidistant1DDataArrayFrom2DDataArray()

static DataArray1D ExtractEquidistant1DDataArrayFrom2DDataArray	(	DataArray2D	dataArray2D,
		VectorD	startPoint,
		VectorD	endPoint,
		bool	enforceSteppedInterpolation,
		int	noOfPointsToExtract,
		double	newStartCoordinate,
		string	commentOfCoordinates,
		PhysicalProperty	physicalPropertyOfCoordinate
	)

static

Method for extracting an equidistantly sampled 1D data array from any 2D data array. This will be done along a line which has to be specified.

Parameters

dataArray2D	DataArray2D to extract the 1D data from.
startPoint	Start coordinates of extraction.
endPoint	End coordinates of extraction.
enforceSteppedInterpolation	If `true`, the extraction will be done from stepped data instead of using the data array's own interpolation method.
noOfPointsToExtract	The number of points to be extracted.
newStartCoordinate	Coordinate which will be set as new start coordinate in the resulting 1D data array.
commentOfCoordinates	The description for the new coordinate axis.
physicalPropertyOfCoordinate	The physical property to be used for the result.

Returns: Result of an equidistant 1D extraction in a 2D data array.

Exceptions

ArgumentOutOfRangeException	Less than two data points to extract.
ArgumentException	Start point and end point of extraction must not be identical.
System.ArgumentException	Start point and end point of extraction must not be identical.

◆ ExtractRangeSelection()

static DataArray1D ExtractRangeSelection	(	DataArray1D	inputDataArray,
		RectangleOfPixels	rangeMarker,
		double	rangeEndPoint
	)

static

Extracts the given range of a one-dimensional data array.

Parameters

inputDataArray	The data array from which the selected range shall be extracted.
rangeMarker	The range marker indicating the region to extract.
rangeEndPoint	The physical coordinate of the range's end point.

Returns: The extracted data array.

Exceptions

System.ArgumentException The range selection contains only one sampling point. From this selection a one-dimensional data array cannot be extracted.

◆ ExtractRectangularSelection()

static DataArray2D ExtractRectangularSelection	(	DataArray2D	inputDataArray,
		RectangleOfPixels	rectangleMarker,
		VectorD	rectEndPoint
	)

static

Extracts the selected rectangular region of a two-dimensional data array.

Parameters

inputDataArray	The data array from which the selected rectangle marker shall be extracted.
rectangleMarker	The rectangle marker indicating the selected region of the field.
rectEndPoint	The physical coordinates of the rectangle's upper right point.

Returns: The extracted data array.

Exceptions

System.ArgumentException The rectangular selection contains only one sampling point in x- or y-direction. From this selection a two-dimensional data array cannot be extracted.

◆ ExtractSubsetDataAtOnePoint() [1/2]

static DataArray1D ExtractSubsetDataAtOnePoint	(	DataArray1D	dataArray1D,
		double	extractionCoordinate,
		bool	enforceSteppedInterpolation,
		string	newCommentOfData,
		double	newStartCoordinate,
		double	newSamplingDistance,
		string	commentOfNewCoordinate,
		PhysicalProperty	physicalPropertyOfNewCoordinate,
		out PhysicalValueComplex	singleValueForSingleSubset
	)

static

Extracts the subset data at one point.

Parameters

dataArray1D	The data array from which the data is extracted.
extractionCoordinate	The extraction coordinate.
enforceSteppedInterpolation	If `true`, a stepped interpolation (i.e. Nearest Neighbor or Constant Interval) will be used, no matter what the DataArrays own interpolation method is.
newCommentOfData	The new comment of data.
newStartCoordinate	The new start coordinate.
newSamplingDistance	The new sampling distance.
commentOfNewCoordinate	The new comment of the coordinate axis.
physicalPropertyOfNewCoordinate	The new physical property of the coordinate axis.
singleValueForSingleSubset	Out parameter returning the single value in case the given data array has only one subset.

Returns: A DataArray1D with the extracted data.

Exceptions

System.ArgumentException The given coordinate lies outside the coordinate range of the Numerical Data Array. or The subsets have different physical properties.

◆ ExtractSubsetDataAtOnePoint() [2/2]

static DataArray1D ExtractSubsetDataAtOnePoint	(	DataArray2D	dataArray2D,
		VectorD	extractionCoordinates,
		bool	enforceSteppedInterpolation,
		string	newCommentOfData,
		double	newStartCoordinate,
		double	newSamplingDistance,
		string	commentOfNewCoordinate,
		PhysicalProperty	physicalPropertyOfNewCoordinate,
		out PhysicalValueComplex	singleValueForSingleSubset
	)

static

Extracts the subset data at one point.

Parameters

dataArray2D	The data array from which the data is extracted.
extractionCoordinates	The extraction coordinates.
enforceSteppedInterpolation	If `true`, a stepped interpolation (i.e. Nearest Neighbor or Constant Interval) will be used, no matter what the DataArrays own interpolation method is.
newCommentOfData	The new comment of data.
newStartCoordinate	The new start coordinate.
newSamplingDistance	The new sampling distance.
commentOfNewCoordinate	The new comment of the coordinate axis.
physicalPropertyOfNewCoordinate	The new physical property of the coordinate axis.
singleValueForSingleSubset	Out parameter returning the single value in case the given data array has only one subset.

Returns: A DataArray1D with the extracted data.

Exceptions

System.ArgumentException The given coordinate lies outside the coordinate range of the Numerical Data Array. or The subsets have different physical properties.

◆ ExtractSubsetsFromDataArray() [1/2]

static ChromaticFieldsSetBase ExtractSubsetsFromDataArray	(	ChromaticFieldsSetBase	cfsBase,
		int[]	indicesToBeKept
	)

static

Method that extracts subsets from a data array

Parameters

cfsBase	Chromatic Fields Set to extract subsets from.
indicesToBeKept	The indices of the subsets to extract.

Returns: A data array with extracted subsets.

Exceptions

System.ArgumentException Method works for DataArray1D, DataArray2D, and DataArrayGridLess only.

◆ ExtractSubsetsFromDataArray() [2/2]

static DataArrayBase ExtractSubsetsFromDataArray	(	DataArrayBase	dataArrayBase,
		int[]	indicesToBeKept
	)

static

Method that extracts subsets from a data array

Parameters

dataArrayBase	Data array to extract subsets from.
indicesToBeKept	The indices of the subsets to extract.

Returns: A data array with extracted subsets.

Exceptions

System.ArgumentException Method works for DataArray1D, DataArray2D, and DataArrayGridLess only.

◆ FillSelection()

static DataArrayBase FillSelection	(	DataArrayBase	dataArray,
		Complex	fillValue,
		RectangleOfPixels	regionMarker,
		bool	useInverseSelection,
		int[]	subsetIndices
	)

static

Fills the selected region of the data array with the specified value.

Parameters

dataArray	The data array to manipulate.
fillValue	The value with which the selected region shall be filled.
regionMarker	The region of the field that shall be filled.
useInverseSelection	If set to `true` the inverse of the selection is filled.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The manipulated data array.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ FourierTransformationOfDataArray()

static DataArrayBase FourierTransformationOfDataArray	(	DataArrayBase	dataArray,
		bool	useNumericalFT,
		bool	useInverseFT
	)

static

Applies a FFT to a data array.

Parameters

dataArray	Data array to be transformed. It has to be equidistant. The coordinates have to have one of the properties 'length', 'wave number', 'time', 'temporal frequency' or 'no unit'. The coordinates has to be centered around zero.
useNumericalFT	If `TRUE`, a numerical FFT instead of a physical one is done.
useInverseFT	If `TRUE`, an inverse FFT is done.

Returns: Fourier transform of input DA.

Exceptions

System.ArgumentException	Operation is allowed for equidistant arrays only. or The coordinate 0 has to be in the center of the array. or Operation is allowed for equidistant arrays only.
System.Exception	Type of data array is not supported.

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [1/3]

static void GetDifferentCoordinateParametersOfTwoDataArrays	(	DataArray1D	dataArray_1,
		DataArray1D	dataArray_2,
		bool	checkWithTolerance,
		out List<(string propName, string prop_1, string prop_2, bool samplingRelated)>	differences
	)

static

Gets all data array differences related to the coordinates.

Parameters

dataArray_1	First data array for comparison.
dataArray_2	Second data array for comparison.
checkWithTolerance	Do the comparison with some tolerance?
differences	List of all differences related to the coordinates.

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [2/3]

static void GetDifferentCoordinateParametersOfTwoDataArrays	(	DataArray2D	dataArray_1,
		DataArray2D	dataArray_2,
		bool	checkWithTolerance,
		out List<(string propName, string prop_1, string prop_2, bool samplingRelated)>	differences_X,
		out List<(string propName, string prop_1, string prop_2, bool samplingRelated)>	differences_Y
	)

static

Gets all data array differences related to the coordinates.

Parameters

dataArray_1	First data array for comparison.
dataArray_2	Second data array for comparison.
checkWithTolerance	Do the comparison with some tolerance?
differences_X	List of all differences related to the x-coordinates.
differences_Y	List of all differences related to the y-coordinates.

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [3/3]

static void GetDifferentCoordinateParametersOfTwoDataArrays	(	DataArrayGridLess	dataArray_1,
		DataArrayGridLess	dataArray_2,
		bool	checkWithTolerance,
		out List<(string propName, string prop_1, string prop_2, bool samplingRelated)>	differences
	)

static

Gets all data array differences related to the coordinates.

Parameters

dataArray_1	First data array for comparison.
dataArray_2	Second data array for comparison.
checkWithTolerance	Do the comparison with some tolerance?
differences	List of all differences.

◆ GetTemporalSamplingOfRealPart()

static DataArrayBase GetTemporalSamplingOfRealPart	(	DataArrayBase	numericalDataArray,
		int	numberOfFrames,
		bool	treatAsElectricField
	)

static

Get temporal sampling of real part of first data subset over one period. The real part of the given data array is multiplied with exp(i*omega*t) [=exp(i*2PI*[t/T])].

Parameters

numericalDataArray	Data Array to be temporally sampled.
numberOfFrames	Temporal sampling count n.
treatAsElectricField	If `true`, the data re treated as being an electric field, as well as the result. Note that there is a scaling factor of 2 in case of an electric field. See the manual for more information.

Returns: Data Array with n subsets - one for each temporal frame.

◆ LiftPositive()

static DataArrayBase LiftPositive	(	DataArrayBase	dataArray,
		int[]	subsetIndices
	)

static

Lifts the values of a data array in a way no negative values occur in the real part anymore.

Parameters

dataArray	The data array which shall be lifted.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The manipulated data array.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ MirrorDataArray1D_Horizontally()

static DataArray1D MirrorDataArray1D_Horizontally	(	DataArray1D	dataArray,
		int[]	subsetIndices
	)

static

Method which performs a horizontal mirror operation on a DataArray1D.

Parameters

dataArray	The data array to be manipulated.
subsetIndices	One or more subset indices which shall be manipulated. If none is specified, then all subsets are manipulated.

Returns: Data array with mirrored subset(s).

◆ MirrorDataArray2D_Horizontally()

static DataArray2D MirrorDataArray2D_Horizontally	(	DataArray2D	dataArray,
		int[]	subsetIndices
	)

static

Method which performs a horizontal mirror operation on a DataArray2D.

Parameters

dataArray	The data array to be manipulated.
subsetIndices	One or more subset indices which shall be manipulated. If none is specified, then all subsets are manipulated.

Returns: Data array with mirrored subset(s).

◆ MirrorDataArray2D_Vertically()

static DataArray2D MirrorDataArray2D_Vertically	(	DataArray2D	dataArray,
		int[]	subsetIndices
	)

static

Method which performs a vertical mirror operation on a DataArray2D.

Parameters

dataArray	The data array to be manipulated.
subsetIndices	One or more subset indices which shall be manipulated. If none is specified, then all subsets are manipulated.

Returns: Data array with mirrored subset(s).

◆ ModifyPhase()

static DataArrayBase ModifyPhase	(	DataArrayBase	dataArrayBase,
		PhaseModifyOperation	operation,
		double	wavelength,
		bool	useQuantization,
		int	numberOfLevels,
		double	doubleParameter,
		bool	hermitian,
		bool	superimpose,
		int[]	subsetIndices
	)

static

Static method which modifies the phase in various ways.

Parameters

dataArrayBase	The data array document to manipulate.
operation	Operation to be applied to the phase.
wavelength	Wavelength to be used in case of lens or spherical phase.
useQuantization	if set to `true` the random phase is quantized..
numberOfLevels	The number of quantization levels. Only has an effect if the random phase is quantized.
doubleParameter	Double parameter whose meaning depends on the chosen operation.
hermitian	Hermitian option (for Random)
superimpose	If `true`, the old phase will be superimposed with the new one, otherwise it will be replaced.
subsetIndices	One or more subset indices which shall be manipulated. If none is specified, then all subsets are manipulated.

Returns: Data array with manipulated phase.

Exceptions

ArgumentException	Operation is defined for equidistant data only. or Method works for DataArray1D and DataArray2D only.
Exception	Case not found.

◆ MultiplyConstant_Complex()

static DataArrayBase MultiplyConstant_Complex	(	DataArrayBase	dataArray,
		Complex	constant,
		int[]	subsetIndices
	)

static

Multiply a constant with certain subsets. The operation will be a complex multiplication.

Parameters

dataArray	The data array to manipulate.
constant	The complex constant to be used for the operation.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the multiplication.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ MultiplyConstant_Separately()

static DataArrayBase MultiplyConstant_Separately	(	DataArrayBase	dataArray,
		double	realPartOrAmplitude,
		double	imaginaryPartOrPhase,
		bool	amplitudePhaseRepresentation,
		int[]	subsetIndices
	)

static

Multiply a constant with certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively.

Parameters

dataArray	The data array to manipulate.
realPartOrAmplitude	The value multiplied to the real part or the amplitude.
imaginaryPartOrPhase	The value multiplied to the imaginary part or the phase.
amplitudePhaseRepresentation	If set to `true` amplitude and phase are given. Otherwise real and imaginary part are given.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the multiplication.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ Normalize()

static DataArrayBase Normalize	(	DataArrayBase	dataArray,
		RectangleOfPixels	regionMarker = `null`,
		int[]	subsetIndices
	)

static

Normalizes a data array, i.e. brings the amplitude into the range 0 ... +1 and the real part into the range -1 ... +1.

Parameters

dataArray	The data array which shall be normalized.
regionMarker	If this parameter is set only the specified region is taken into account for the calculation of the maximum being the normalization reference. Can be omitted or set to `null` if the whole data shall be evaluated.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The normalized data array.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ PeriodicReplicationOfDataArray()

static DataArrayBase PeriodicReplicationOfDataArray	(	DataArrayBase	dataArrayBase,
		VectorD	replicationFactors,
		bool	keepOriginalInCenter
	)

static

Method for periodic replication of data arrays.

Parameters

dataArrayBase	Data array to be replicated periodically.
replicationFactors	Replication factor in x and y. The y-component will be ignored in case of DataArray1D.
keepOriginalInCenter	If `true` (and if the considered dimension is equidistant), the original array will be kept in the center.

Returns: Replicated data array.

Exceptions

System.ArgumentException Non-equidistant data arrays with constant interval interpolation may not be replicated if one of the last intervals is infinite. or Method works for DataArray1D and DataArray2D only.

◆ Quantize()

static DataArrayBase Quantize	(	DataArrayBase	dataArray,
		QuantizationType	quantizationType,
		int	noOfAmplitudeLevels,
		int	noOfPhaseLevels,
		double	softQuantizationFactor
	)

static

Does a quantization of all subsets of a data array.

Parameters

dataArray	Data array to be quantized.
quantizationType	Type of quantization
noOfAmplitudeLevels	Number of amplitude levels after quantization.
noOfPhaseLevels	Number of phase levels after quantization.
softQuantizationFactor	The quantization factor for soft quantization. If a different type is desired, this value will be ignored.

Returns: Quantized data array.

Exceptions

System.Exception Type of data array is not supported.

◆ RaiseToPowerOfConstant_Complex()

static DataArrayBase RaiseToPowerOfConstant_Complex	(	DataArrayBase	dataArray,
		Complex	constant,
		int[]	subsetIndices
	)

static

Raise to the power of a constant with certain subsets. The operation will be a complex exponentiation.

Parameters

dataArray	The data array to manipulate.
constant	The complex constant to be used for the operation.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the exponentiation.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ RaiseToPowerOfConstant_Separately()

static DataArrayBase RaiseToPowerOfConstant_Separately	(	DataArrayBase	dataArray,
		double	realPartOrAmplitude,
		double	imaginaryPartOrPhase,
		bool	amplitudePhaseRepresentation,
		int[]	subsetIndices
	)

static

Raise to the power of a constant with certain subsets. The operation will consist of two independent real valued operations for the complex parts respectively.

Parameters

dataArray	The data array to manipulate.
realPartOrAmplitude	The exponent applied on the real part or the amplitude.
imaginaryPartOrPhase	The exponent applied on the imaginary part or the phase.
amplitudePhaseRepresentation	If set to `true` amplitude and phase are given. Otherwise real and imaginary part are given.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The result of the exponentiation.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ RemovePhaseDislocationsInsideSelection()

static DataArray2D RemovePhaseDislocationsInsideSelection	(	DataArray2D	dataArray,
		RectangleOfPixels	regionMarker,
		int[]	subsetIndices
	)

static

Static function to remove all phase dislocations within the rectangular selection.

Parameters

dataArray	The data array in whose rectangular selection the phase dislocations shall be removed.
regionMarker	If this optional parameter is set only the specified region is taken into account for the calculation of the maximum being the normalization reference.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The data array with removed phase dislocations.

◆ RemoveRedundantData()

static DataArray2D RemoveRedundantData ( DataArray2D inputDataArray )

static

Removes redundant data in a two-dimensional non-equidistant data array with Constant Interval interpolation and one subset. First all columns are scanned whether two consecutive columns have the same data. Then the same is done for all rows.

Parameters

inputDataArray The input data array.

Returns: New data array with removed data. The original data array if no data was removed.

Exceptions

ArgumentException Remove redundant data only works for non-equidistant data arrays with Constant Interval interpolation and one subset.

◆ RemoveSubsetsFromDataArray() [1/2]

static ChromaticFieldsSetBase RemoveSubsetsFromDataArray	(	ChromaticFieldsSetBase	cfsBase,
		int[]	removeIndices
	)

static

Method that removes subsets from a data array

Parameters

cfsBase	Chromatic fields set to remove subsets from.
removeIndices	The indices of the subsets to remove.

Returns: A cfs with removed subsets.

◆ RemoveSubsetsFromDataArray() [2/2]

static DataArrayBase RemoveSubsetsFromDataArray	(	DataArrayBase	dataArrayBase,
		int[]	removeIndices
	)

static

Method that removes subsets from a data array

Parameters

dataArrayBase	Data array to remove subsets from.
removeIndices	The indices of the subsets to remove.

Returns: A data array with removed subsets.

Exceptions

System.ArgumentException Method works for DataArray1D, DataArray2D, and DataArrayGridLess only.

◆ SavitzkyGolayFilter()

static DataArrayBase SavitzkyGolayFilter	(	DataArrayBase	dataArray,
		int	windowSize,
		int	order
	)

static

Applies the Savitzky-Golay-Filter on the given data array. This filter is a special low-pass filter, well adapted for data smoothing.

Parameters

dataArray	The data array.
windowSize	The window size of the filter (in pixels).
order	The order of the filter. The smaller the order the smoother the result. The order should be smaller than filter window size, otherwise the algorithm is not correct.

Returns: The filtered data array.

Exceptions

ArgumentException Selected data array is not equidistantly sampled.

◆ ScaleToValueRange()

static DataArrayBase ScaleToValueRange	(	DataArrayBase	dataArray,
		double	minimum,
		double	maximum,
		bool	cloneDataArray,
		int[]	subsetIndices
	)

static

Normalizes a data array, i.e. brings the amplitude into the range 0 ... +1 and the real part into the range -1 ... +1.

Parameters

dataArray	The data array which shall be normalized.
minimum	The minimum data value in the resulting data array.
maximum	The maximum data value in the resulting data array.
cloneDataArray	If set to `true` the data array. Otherwise the original data array is manipulated which is faster.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The scaled data array.

Exceptions

ArgumentException Operation only supported for real-valued data. or Method does not work for this type of data array.

◆ SetToConstant()

static DataArrayBase SetToConstant	(	DataArrayBase	dataArray,
		Complex	constant,
		int[]	subsetIndices
	)

static

Set certain subsets to a constant.

Parameters

dataArray	The data array to manipulate.
constant	The complex constant to be used for the operation.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The data array with the constant value.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ SumOfAllSubsets()

static DataArrayBase SumOfAllSubsets	(	DataArrayBase	dataArrayBase,
		bool	complexAddition,
		ComplexPart	partToSumInComplexCase
	)

static

Method which allows a complex-valued or real-valued summation of all subsets of a data array.

Parameters

dataArrayBase	Data array to sum the subsets for.
complexAddition	If `false`, the parameter partToSumInComplexCase determines which complex part is to be summed.
partToSumInComplexCase	Complex part to be summed.

Returns: Sum of all subsets.

Exceptions

System.ArgumentException Method works for DataArray1D and DataArray2D only.

◆ TransposeDataArray2D() [1/2]

static DataArray2D TransposeDataArray2D ( DataArray2D dataArray )

static

Method which transposes a DataArray2D, which swaps all x and y properties.

Parameters

dataArray Data array to be transposed.

Returns: The transposed data array.

◆ TransposeDataArray2D() [2/2]

static DataArrayGridLess TransposeDataArray2D ( DataArrayGridLess dataArray )

static

Method which transposes a DataArrayGridLess, which swaps all x and y properties.

Parameters

dataArray Data array to be transposed.

Returns: DataArrayGridLess with transposed coordinates.

Exceptions

System.ArgumentException This manipulation works for 2D data only.

◆ UnwrapPhase()

static DataArrayBase UnwrapPhase	(	DataArrayBase	dataArray,
		int[]	subsetIndices
	)

static

Unwraps the phase, i.e. removes the 2 \(\pi\) jumps.

Parameters

dataArray	The data array to manipulate.
subsetIndices	One or more subset indices which shall be evaluated. If none is specified, then all subsets are evaluated.

Returns: The data array with the unwrapped phase.

Exceptions

ArgumentException Operation works for 1D and gridded 2D data arrays only.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddConstant_Complex()

◆ AddConstant_Separately()

◆ AppendSubsetsFromAnotherDataArray()

◆ AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates() [1/2]

◆ AppendSubsetsFromAnotherDataArrayWithInterpolationToTargetCoordinates() [2/2]

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [1/3]

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [2/3]

◆ AppendSubsetsFromAnotherDataArrayWithMerging() [3/3]

◆ ArrayArrayOperation()

◆ ChangeInterpolationMethodEquidistant()

◆ CheckForIdenticalCoordinateParametersOfTwoDataArrays()

◆ ClipValues()

◆ ConjugatePhase()

◆ Convolution() [1/2]

◆ Convolution() [2/2]

◆ CreatePointCloudAddOn() [1/4]

◆ CreatePointCloudAddOn() [2/4]

◆ CreatePointCloudAddOn() [3/4]

◆ CreatePointCloudAddOn() [4/4]

◆ CreateRegionAddOn() [1/3]

◆ CreateRegionAddOn() [2/3]

◆ CreateRegionAddOn() [3/3]

◆ DiscreteOversampling()

◆ DivideByConstant_Complex()

◆ DivideByConstant_Separately()

◆ DoFieldQuantityOperationOnDataArray()

◆ EquidistantResamplingOfDataArray()

◆ ExtractEquidistant1DDataArrayFrom2DDataArray()

◆ ExtractRangeSelection()

◆ ExtractRectangularSelection()

◆ ExtractSubsetDataAtOnePoint() [1/2]

◆ ExtractSubsetDataAtOnePoint() [2/2]

◆ ExtractSubsetsFromDataArray() [1/2]

◆ ExtractSubsetsFromDataArray() [2/2]

◆ FillSelection()

◆ FourierTransformationOfDataArray()

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [1/3]

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [2/3]

◆ GetDifferentCoordinateParametersOfTwoDataArrays() [3/3]

◆ GetTemporalSamplingOfRealPart()

◆ LiftPositive()

◆ MirrorDataArray1D_Horizontally()

◆ MirrorDataArray2D_Horizontally()

◆ MirrorDataArray2D_Vertically()

◆ ModifyPhase()

◆ MultiplyConstant_Complex()

◆ MultiplyConstant_Separately()

◆ Normalize()

◆ PeriodicReplicationOfDataArray()

◆ Quantize()

◆ RaiseToPowerOfConstant_Complex()

◆ RaiseToPowerOfConstant_Separately()

◆ RemovePhaseDislocationsInsideSelection()

◆ RemoveRedundantData()

◆ RemoveSubsetsFromDataArray() [1/2]

◆ RemoveSubsetsFromDataArray() [2/2]

◆ SavitzkyGolayFilter()

◆ ScaleToValueRange()

◆ SetToConstant()

◆ SumOfAllSubsets()

◆ TransposeDataArray2D() [1/2]

◆ TransposeDataArray2D() [2/2]

◆ UnwrapPhase()