Click or drag to resize

DataTableToMatrixConverter Class

Class that helps to assembly numerical matrix data from a DataTable and selected data columns, seclected data rows, and selected property columns />.
Inheritance Hierarchy
SystemObject
  Altaxo.DataDataTableToMatrixConverter

Namespace: Altaxo.Data
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class DataTableToMatrixConverter

The DataTableToMatrixConverter type exposes the following members.

Constructors
 NameDescription
Public methodDataTableToMatrixConverter Initializes a new instance of the DataTableToMatrixConverter class.
Top
Properties
 NameDescription
Public propertyColumnHeaderColumn Gets the resulting column header column. Attention: to correspond elements in this column to the columns of the resulting matrix, GetParticipatingDataColumns must be used to get the collection of indices. Alternatively, use ColumnHeaderVector. The column header column is a column that correlate each column of the resulting matrix to a corresponding physical value. This value can be used for instance for calculating the x- or y- position in the coordinate system.
Public propertyColumnHeaderColumns Gets all selected column header columns.
Public propertyColumnHeaderVector Gets the resulting column header vector. Each member of this vector corresponds to the column of the matrix with the same index. The column header vector is a vector that correlate each column of the resulting matrix to a corresponding physical value. This value can be used for instance for calculating the x- or y- position in the coordinate system.
Public propertyDataColumnsGroupNumber Gets the common group number of all data columns that are included in the matrix.
Public propertyMatrixGenerator Sets the matrix generator that is used to generate the resulting matrix.
Public propertyNumberOfColumns Gets the number of columns of the resulting matrix.
Public propertyNumberOfRows Gets the number of rows of the resulting matrix.
Public propertyReplacementValueForInfiniteMatrixElements Sets a value that is used to replace all values in the matrix that are Infinite.
Public propertyReplacementValueForNaNMatrixElements Sets a value that is used to replace all values in the matrix that are NaN.
Public propertyResultingMatrix Gets the resulting matrix. The resulting matrix is available only after calling Execute.
Public propertyRowHeaderColumn Gets the resulting row header column. Attention: to correspond elements in this column to the rows of the resulting matrix, GetParticipatingDataRows must be used to get the collection of indices. Alternatively, use RowHeaderVector. The row header column is a column that correlate each row of the resulting matrix to a corresponding physical value. This value can be used for instance for calculating the x- or y- position in the coordinate system.
Public propertyRowHeaderVector Gets the resulting row header vector. Each member of this vector corresponds to the row of the matrix with the same index. The row header vector is a vector that correlate each row of the resulting matrix to a corresponding physical value. This value can be used for instance for calculating the x- or y- position in the coordinate system.
Public propertySelectedDataColumns Sets the collection of indices of selected data columns.
Public propertySelectedDataRows Sets the collection of indices of selected data rows.
Public propertySelectedPropertyColumns Sets the collection of indices of selected property columns.
Top
Methods
 NameDescription
Public methodAreAllAvailableColumnsOfGroupIncluded Determines, whether all available columns (with same group number and ColumnKind.V) are included in the matrix.
Public methodAreAllAvailableRowsIncluded Determines, whether all available rows are included in the matrix.
Public methodStatic memberCheckContentForNaNandInfiniteValues Checks the content of a matrix area of a table for NaN and infinite values. If such values are found, an InvalidOperationException is thrown with a diagnostic message.
Public methodColumnSpacingOrValue Get the uniform column spacing value, or, if the column header vector is not uniformly spaced, a default value provided in defaultValue.
Protected methodDefaultMatrixGenerator Gets the defaults the matrix generator, which generates a JaggedArrayMatrix.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExecute Performs the assembling for the resulting matrix and the row / column header vectors. After calling this function, the properties ResultingMatrix, RowHeaderVector and ColumnHeaderVector are available.
Protected methodFillMatrix Creates the resulting matrix and fills it with values.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetColumnSpacing Get the uniform column spacing value, or, if the column header vector is not uniformly spaced, null.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetParticipatingDataColumns Gets the indices of the data columns of the data table that contribute to the matrix.
Public methodStatic memberGetParticipatingDataColumns(DataTable, IAscendingIntegerCollection) Gets the indices of data columns that can participate in a matrix area, by providing a data table and the selected column. The participating data columns must have ColumnKind.V, and must share the same group number.
Public methodGetParticipatingDataRows Gets the indices of the data rows of the table that contribute to the matrix.
Public methodStatic memberGetParticipatingDataRows(DataTable, IAscendingIntegerCollection, IAscendingIntegerCollection) Gets the data rows that participate in a matrix area by providing a table, the collection of selected data rows, and the collection of selected data columns.
Public methodGetRowSpacing Get the uniform row spacing value, or, if the row header vector is not uniformly spaced, null.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRowSpacingOrValue Get the uniform row spacing value, or, if the row header vector is not uniformly spaced, a default value provided in defaultValue.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetColumnSpacing Tries to get the uniform column spacing value, or, if the column header vector is not uniformly spaced, false is returned along with a diagnostic message.
Public methodStatic memberTryGetRowOrColumnSpacing Tries to get the uniform spacing value of a vector.
Public methodTryGetRowSpacing Tries to get the uniform row spacing value, or, if the row header vector is not uniformly spaced, false is returned along with a diagnostic message.
Top
Fields
 NameDescription
Protected field_matrixGenerator Function that is used to generate a writeable matrix. First argument is number of rows, the 2nd argument is the number of columns of the matrix. The result shold be a writeable matrix with the corresponding number of rows and columns.
Protected field_replacementValueForInfiniteMatrixElementsIf this value is not null, it is used to replace all occurences of values in the matrix that are infinite.
Protected field_replacementValueForNaNMatrixElementsIf this value is not null, it is used to replace all values in the matrix that are NaN.
Protected field_selectedColumnsCollection of selected data columns.
Protected field_selectedPropertyColumnsCollection of selected property columns.
Protected field_selectedRowsCollection of selected data rows.
Protected field_sourceTableUnderlying data table.
Top
See Also