Data |
Class that helps to assembly numerical matrix data from a DataTable and selected data columns, seclected data rows, and selected property columns />.
Inheritance HierarchyNamespace: Altaxo.Data
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3261.0 (4.8.3261.0)
SyntaxC#
public class DataTableToMatrixConverter
The DataTableToMatrixConverter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataTableToMatrixConverter | Initializes a new instance of the DataTableToMatrixConverter class. |
Properties| Name | Description | |
|---|---|---|
 | ColumnHeaderColumn | 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. |
| ColumnHeaderColumns | Gets all selected column header columns. |
| ColumnHeaderVector | 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. |
| DataColumnsGroupNumber | Gets the common group number of all data columns that are included in the matrix. |
| MatrixGenerator | Sets the matrix generator that is used to generate the resulting matrix. |
| NumberOfColumns | Gets the number of columns of the resulting matrix. |
| NumberOfRows | Gets the number of rows of the resulting matrix. |
| ReplacementValueForInfiniteMatrixElements | Sets a value that is used to replace all values in the matrix that are Infinite. |
| ReplacementValueForNaNMatrixElements | Sets a value that is used to replace all values in the matrix that are NaN. |
| ResultingMatrix | Gets the resulting matrix. The resulting matrix is available only after calling Execute. |
| RowHeaderColumn | 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. |
| RowHeaderVector | 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. |
| SelectedDataColumns | Sets the collection of indices of selected data columns. |
| SelectedDataRows | Sets the collection of indices of selected data rows. |
| SelectedPropertyColumns | Sets the collection of indices of selected property columns. |
Methods| Name | Description | |
|---|---|---|
| AreAllAvailableColumnsOfGroupIncluded | Determines, whether all available columns (with same group number and ColumnKind.V) are included in the matrix. |
| AreAllAvailableRowsIncluded | Determines, whether all available rows are included in the matrix. |
 | CheckContentForNaNandInfiniteValues | 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. |
| ColumnSpacingOrValue | Get the uniform column spacing value, or, if the column header vector is not uniformly spaced, a default value provided in defaultValue. |
 | DefaultMatrixGenerator | Gets the defaults the matrix generator, which generates a JaggedArrayMatrix. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Execute | 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. |
| FillMatrix | Creates the resulting matrix and fills it with values. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetColumnSpacing | Get the uniform column spacing value, or, if the column header vector is not uniformly spaced, null. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetParticipatingDataColumns | Gets the indices of the data columns of the data table that contribute to the matrix. |
| GetParticipatingDataColumns(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. |
| GetParticipatingDataRows | Gets the indices of the data rows of the table that contribute to the matrix. |
| GetParticipatingDataRows(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. |
| GetRowSpacing | Get the uniform row spacing value, or, if the row header vector is not uniformly spaced, null. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RowSpacingOrValue | Get the uniform row spacing value, or, if the row header vector is not uniformly spaced, a default value provided in defaultValue. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetColumnSpacing | 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. |
| TryGetRowOrColumnSpacing | Tries to get the uniform spacing value of a vector. |
| TryGetRowSpacing | 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. |
Fields| Name | Description | |
|---|---|---|
 | _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. |
| _replacementValueForInfiniteMatrixElements | If this value is not null, it is used to replace all occurences of values in the matrix that are infinite. |
| _replacementValueForNaNMatrixElements | If this value is not null, it is used to replace all values in the matrix that are NaN. |
| _selectedColumns | Collection of selected data columns. |
| _selectedPropertyColumns | Collection of selected property columns. |
| _selectedRows | Collection of selected data rows. |
| _sourceTable | Underlying data table. |
See Also