Engee documentation

Overwrite Values

Overwrite the submatrix or subdiagonal of the input data.

overwrite values

Description

The Overwrite Values block overwrites the submatrix or subdiagonal of the input matrix. The values to overwrite can be set either via the Overwrite with parameter or via an additional input, which allows to overwrite the elements with values changing at each moment of time.

overwrite values 1

Ports

Input

# A — input data
scalar | vector | matrix

Details

Specify the input data as a scalar, vector or matrix.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool.
Complex numbers support

No

# V — rewritable values
scalar | vector | matrix

Details

Specify the values to overwrite the specified part of the input matrix with. The dimensionality of this parameter must match the dimensionality of the part of the matrix that is specified to be overwritten by the associated parameters Row span and Column span in the block dialogue box.

Dependencies

To use this port, set the Source of overwriting value(s) parameter to Second input port.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool.
Complex numbers support

No

Output

# B — modified data
scalar | vector | matrix

Details

Data that is modified based on the Row span and Column span parameters in the block dialogue box and returned as a scalar, vector or matrix.

The output has the same dimensionality as the original input signal. The input and output of this block must have the same data type.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool.
Complex numbers support

No

Parameters

Main

# Overwrite — overwrite submatrix or diagonal
Submatrix | Diagonal

Details

Specifies the area to overwrite: the submatrix or the specified part of the diagonal.

Values

Submatrix | Diagonal
Default value

Submatrix
Program usage name

Overwrite
Tunable

No
Evaluatable

No

# Source of overwriting value(s) — source of rewritable values
Specify via dialog | Second input port

Details

Specify the source of the values to be overwritten:

  • Specify via dialog - specify the values to be overwritten via the Overwrite with parameter. The block uses the same overwrite values to overwrite the specified portion of the input data at each time step.

  • Second input port - Specifying values to overwrite via the block’s second input port, V. Use this setting to provide different overwrite values at each time step. The output signal inherits its dimensionality and speed from the input signal, not the overwrite values.

The rate at which you provide overwrite values through input port V must match the rate at which the block receives each input matrix through input port A. In other words, the input signals must have the same sampling time.

Values

Specify via dialog | Second input port
Default value

Specify via dialog
Program usage name

SourceOfOverwritingValue
Tunable

No
Evaluatable

No

# Overwrite with — overwrite the value
Scalar / array of real and/or complex numbers

Details

Specify the value to overwrite the specified part of the input matrix with. The dimensionality of this parameter must match the dimensionality of the part of the matrix you specify to overwrite using the associated Row span and Column span parameters in the block dialogue box.

Default value

0
Program usage name

OverwriteWith
Tunable

No
Evaluatable

Yes

# Diagonal span — diagonal range
All elements | One element | Range of elements

Details

Specify the range of diagonal elements to be overwritten. You can set this parameter to one of the following values:

  • Range of elements - overwriting of a part of the input diagonal to be specified in the Starting element and Ending element parameters.

  • All elements - overwriting of the whole input diagonal.

  • One element - overwriting of one element of the diagonal, which must be specified in the Element parameter.

If One element or Range of elements is selected for the Diagonal span parameter, it is necessary to additionally specify diagonal elements to be overwritten by specifying Element or Starting element and Ending element parameters.

Dependencies

To enable this parameter, set the Overwrite parameter to `Diagonal'.

Values

All elements | One element | Range of elements
Default value

Range of elements
Program usage name

DiagSpan
Tunable

No
Evaluatable

No

# Starting element — initial element
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the element of the input diagonal that is the first element in the subdiagonal to be overwritten. You can set this parameter to one of the following values:

  • Index - k diagonal element, where k is the value of the Element index or Starting element index parameter.

  • First - the diagonal element in the first line of the input file.

  • Offset from last - diagonal element in the line with index M- offset, where M is the number of input lines and offset is the value given in the Element offset and Starting element offset parameters.

  • Last - the diagonal element in the last input line.

  • Offset from middle - diagonal element in the input line with index floor (M/2 + 1), where M is the number of input lines, and offset is the value specified in the Element offset and Starting element offset parameters.

  • Middle - diagonal element in the input line with index floor (M/2 + 1), where M is the number of input lines.

Dependencies

To enable the Starting element parameter, set the Element span parameter to Range of elements.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

Index
Program usage name

DiagStartMode
Tunable

No
Evaluatable

No

# Starting element index — initial element index
Integer

Details

Specify the initial index of the element of the input diagonal that is the first element of the subdiagonal to be overwritten as a positive integer.

Dependencies

To enable the Starting element index parameter, set the Starting element parameter to Index.

Default value

2
Program usage name

DiagStartIndex
Tunable

No
Evaluatable

Yes

# Starting element offset — initial element offset
Integer

Details

Specify the offset of the input diagonal element that is the first element of the subdiagonal to be overwritten. Set Starting element to one of the following values:

  • Offset from middle - specify the value of this parameter as an integer.

  • Offset from last - specify the value of this parameter as a non-negative integer.

Dependencies

To enable the Starting element offset parameter, set the Starting element parameter to Offset from middle or Offset from last.

Default value

2
Program usage name

DiagStartOffset
Tunable

No
Evaluatable

Yes

# Ending element — finite element
Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the element of the input diagonal that is the last element of the subdiagonal to be overwritten. You can set this parameter to one of the following values:

  • Index - k diagonal element, where k is the value of the Ending element index parameter.

  • Last - the diagonal element in the last row of the input data.

  • Offset from last - diagonal element in the row with index M - offset, where M is the number of input rows and offset is the value given in the Ending element offset parameter.

  • Offset from middle is the diagonal element in the input line with index floor (M/2 + 1 - offset), where M is the number of input lines and offset is the value specified in the Ending element offset parameter.

  • Middle is the diagonal element in the input row with index floor (M/2 + 1), where M is the number of input rows.

Dependencies

To enable this parameter, set the Element span parameter to Range of elements and the Starting element parameter to any value other than Last.

Values

Index | Offset from last | Last | Offset from middle | Middle
Default value

Index
Program usage name

DiagEndMode
Tunable

No
Evaluatable

No

# Ending element index — finite element index
Integer

Details

Specify the index of the element of the input diagonal that is the last element of the subdiagonal to be overwritten as a positive integer.

Dependencies

To enable this parameter, set the Ending element parameter to Index.

Default value

4
Program usage name

DiagEndIndex
Tunable

No
Evaluatable

Yes

# Ending element offset — finite element displacement
Integer

Details

Specify the offset of the input diagonal element that is the last element of the subdiagonal to be overwritten as a non-negative integer.

Dependencies

To enable this parameter, set the Ending element parameter to Offset from middle or Offset from last.

Default value

4
Program usage name

DiagEndOffset
Tunable

No
Evaluatable

Yes

# Element — element
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input diagonal element that is the first element in the subdiagonal to be overwritten. You can set this parameter to one of the following values:

  • Index - k diagonal element, where k is the value of the Element index or Starting element index parameter.

  • First - the diagonal element in the first line of the input file.

  • Offset from last - diagonal element in the line with index M - offset, where M is the number of input lines and offset is the value specified in the Element offset and Starting element offset parameters.

  • Lost is the diagonal element in the last input line.

  • Offset from middle - diagonal element in the input line with index floor (M/2 + 1 - offset), where M is the number of input lines and offset is the value specified in the Element offset and Starting element offset parameters.

  • Middle is the diagonal element in the input line with index floor (M/2 + 1), where M is the number of input lines.

Dependencies

To enable this parameter, set the Element span parameter to One element.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

Index
Program usage name

OneDiagStartMode
Tunable

No
Evaluatable

No

# Element index — element index
Integer

Details

Specify the element index of the element of the input diagonal that is the first element of the subdiagonal to be overwritten as a positive integer.

Dependencies

To enable this parameter, set the Element parameter to Index.

Default value

2
Program usage name

OneDiagStartIndex
Tunable

No
Evaluatable

Yes

# Element offset — element offset
Integer

Details

Specify the offset of the element of the input diagonal that is the first element of the subdiagonal to be overwritten.

Dependencies

To enable this parameter, set the Element parameter to Offset from middle or Offset from last.

Default value

2
Program usage name

OneDiagStartOffset
Tunable

No
Evaluatable

Yes

# Row span — input string range
All rows | One row | Range of rows

Details

Specify the input string range to overwrite as one of the following:

  • Range of rows - the submatrix contains one or more rows of the input matrix, which should be specified in the Starting row and Ending row parameters.

  • All rows - the submatrix contains all rows of the input matrix.

  • One row - submatrix contains only one row of the input matrix, which should be specified in the Row parameter.

When setting the Row span parameter to One row or Range of rows it is necessary to additionally specify the row(s) contained in the submatrix by specifying the Row or Starting row and Ending row parameters.

Values

All rows | One row | Range of rows
Default value

Range of rows
Program usage name

RowSpan
Tunable

No
Evaluatable

No

# Row — row or header row
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input row that is the first row of the submatrix to be overwritten. You can set this parameter to one of the following values:

  • First - the first line of input.

  • Index - specify the first input row through the Row index and Starting row index parameters.

  • Offset from last - input row with index M - rowOffset, where M is the number of input rows, and rowOffset is the value specified in the Row offset and Starting row offset parameters.

  • Last is the last row of the input.

  • Offset from middle - input row with index floor (M/2 + 1 - rowOffset), where M is the number of input rows and rowOffset is the value specified in the Row offset and Starting row offset parameters.

  • Middle is the input row with index floor (M/2 + 1), where M is the number of input rows.

Dependencies

To enable the Row parameter, set the Row span parameter to One row.

To enable the Starting row parameter, set the Row span parameter to Range of rows.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

First
Program usage name

OneRowStartMode
Tunable

No
Evaluatable

No

# Row index — row index
Integer

Details

Specify the index of the input string, which is the first row of the submatrix that the block overwrites, as a positive integer.

Dependencies

To enable the Row index parameter, set the Row parameter to Index.

To enable the Starting row index parameter, set the Starting row parameter to Index.

Default value

1
Program usage name

OneRowStartIndex
Tunable

No
Evaluatable

Yes

# Row offset — row offset
Integer

Details

Specify the offset of the input row, which is the first row of the submatrix to be overwritten by the block. Set the Row or Starting row parameter to one of the following values:

  • Offset from last - input row with index M - rowOffset, where M is the number of input rows, and rowOffset is the value specified in this parameter.

  • Offset from middle - input string with index floor (M/2 + 1 - rowOffset), where M - number of input rows, and rowOffset - value specified in this parameter.

Dependencies

To enable this parameter, set the Row parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

OneRowStartOffset
Tunable

No
Evaluatable

Yes

# Starting row — initial line
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input line that is the first line of the submatrix to be overwritten. You can set this parameter to one of the following values:

  • First - the first line of input.

  • Index º Specify the first input row using the Row index and Starting row index parameters.

  • Offset from last - input row with index M - rowOffset, where M is the number of input rows and rowOffset is the value specified in the Row offset and Starting row offset parameters.

  • Last - the last row of input.

  • Offset from middle is the input row with index floor (M/2 + 1 - rowOffset), where M is the number of input rows, and rowOffset is the value specified in the Row offset and Starting row offset parameters.

  • Middle is the input row with index floor (M/2 + 1), where M is the number of input rows.

Dependencies

To enable this parameter, set the Row span parameter to Range of rows.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

First
Program usage name

RowStartMode
Tunable

No
Evaluatable

No

# Starting row index — start line index
Integer

Details

Specify the index of the input string, which is the first row of the submatrix to be overwritten, as a positive integer.

Dependencies

To enable the Starting row index parameter, set the Starting row parameter to Index.

Default value

1
Program usage name

RowStartIndex
Tunable

No
Evaluatable

Yes

# Starting row offset — row offset
Integer

Details

Specify the offset of the input row, which is the first row of the submatrix to be overwritten. Set the Row/Starting row parameters to one of the following values:

  • Offset from last - input row with index M - rowOffset, where M is the number of input rows and rowOffset is the value specified in this parameter.

  • Offset from middle - input string with index floor (M/2 + 1 - rowOffset), where M - number of input rows, and rowOffset - value specified in this parameter.

Dependencies

To enable this parameter, set the Starting row parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

RowStartOffset
Tunable

No
Evaluatable

Yes

# Ending row — end line
Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input line that is the last line of the submatrix to be overwritten. You can set this parameter to one of the following values:

  • Index - specifying the last input row via the Ending row index parameters.

  • Offset from last - the input row with index M - rowOffset, where M is the number of input rows, and rowOffset is the value specified in the Ending row offset parameter.

  • Last is the last row of the input.

  • Offset from middle is the input row with index floor (M/2 + 1 - rowOffset), where M is the number of input rows and rowOffset is the value specified in the Ending row offset parameter.

  • Middle is the input row with index floor (M/2 + 1), where M is the number of input rows.

Dependencies

To enable the Row parameter, set the Row span parameter to

To enable this parameter, set the Row span parameter to Range of rows and the Starting row parameter to Last.

Values

Index | Offset from last | Last | Offset from middle | Middle
Default value

Last
Program usage name

RowEndMode
Tunable

No
Evaluatable

No

# Ending row index — index of the last row of the submatrix
Integer

Details

Specify the index of the input string that is the last row of the submatrix to be overwritten.

Dependencies

To enable this parameter, set the Ending row parameter to Index.

Default value

1
Program usage name

RowEndIndex
Tunable

No
Evaluatable

Yes

# Ending row offset — end line offset
Integer

Details

Specify the offset of the input row that is the last row of the submatrix to be overwritten. Set the Ending row parameter to one of the following values:

  • Offset from last - input row with index M - rowOffset, where M is the number of input rows, and rowOffset is the value specified in the Ending row offset parameter.

  • Offset from middle - input row with index floor (M/2 + 1 - rowOffset), where M is the number of input rows, and rowOffset is the value specified in the Ending row offset parameter.

Dependencies

To enable this parameter, set the Ending row parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

RowEndOffset
Tunable

No
Evaluatable

Yes

# Column span — input column range
All columns | One column | Range of columns

Details

Specify the range of input columns to overwrite. You can set this parameter to one of the following values:

  • Range of columns - the submatrix contains one or more columns of the input matrix, which should be specified in the Starting column and Ending column parameters.

  • All columns - submatrix contains all columns of the input matrix.

  • One column - submatrix contains only one column of the input matrix, which must be specified in the Column parameter.

If One column or Range of columns is selected for the Column span parameter, it is necessary to additionally specify the column(s) contained in the submatrix by specifying the Column or Starting column and Ending column parameters.

Values

All columns | One column | Range of columns
Default value

Range of columns
Program usage name

ColSpan
Tunable

No
Evaluatable

No

# Column — column
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input column that is the first column of the submatrix to be overwritten by the block. You can set this parameter to one of the following values:

  • First - the first input column.

  • Index - specify the first input column using the Column index and Starting column index parameters.

  • Offset from last - input column with index N - colOffset, where N is the number of input columns and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Last is the last column of the input.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Middle is the input column with index floor (N/2 + 1), where N is the number of input columns.

Dependencies

To enable this parameter, set the Column span parameter to One column.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

First
Program usage name

OneColStartMode
Tunable

No
Evaluatable

No

# Column index — column index

 +
`Integer`
Details

Specify the index of the input column, which is the first column of the submatrix to be overwritten, as a positive integer.

Dependencies

To enable this parameter, set the Column parameter to Index.

Default value

1
Program usage name

OneColStartIndex
Tunable

No
Evaluatable

Yes

# Column offset — column offset
Integer

Details

Specify the offset of the input column that is the first column of the submatrix to be overwritten by the block. Set Starting column to one of the following values:

  • Offset from last - the input column with index N - colOffset, where N is the number of input columns, and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns, and colOffset is the value specified in the Column offset and Starting column offset parameters.

Dependencies

To enable this parameter, set the Column parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

OneColStartOffset
Tunable

No
Evaluatable

Yes

# Starting column — first column
First | Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input column that is the first column of the submatrix to be overwritten by the block. You can set this parameter to one of the following values:

  • First - the first input column.

  • Index - specify the first input column using the Column index and Starting column index parameters.

  • Offset from last - input column with index N - colOffset, where N is the number of input columns and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Last is the last column of the input.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Middle is the input column with index floor (N/2 + 1), where N is the number of input columns.

Dependencies

To enable this parameter, set the Column span parameter to Range of columns.

Values

First | Index | Offset from last | Last | Offset from middle | Middle
Default value

First
Program usage name

ColStartMode
Tunable

No
Evaluatable

No

# Starting column index — first column index
Integer

Details

Specify the index of the input column, which is the first column of the submatrix to be overwritten, as a positive integer.

Dependencies

To enable the Column index parameter, set the Column parameter to Index.

To enable the Starting column index parameter, set the Starting column parameter to Index.

Default value

1
Program usage name

ColStartIndex
Tunable

No
Evaluatable

Yes

# Starting column offset — first column offset
Integer

Details

Specify the offset of the input column that is the first column of the submatrix to be overwritten by the block. Set Starting column to one of the following values:

  • Offset from last - the input column with index N - colOffset, where N is the number of input columns, and colOffset is the value specified in the Column offset and Starting column offset parameters.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns, and colOffset is the value specified in the Column offset and Starting column offset parameters.

Dependencies

To enable this parameter, set the Starting column parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

ColStartOffset
Tunable

No
Evaluatable

Yes

# Ending column — last column
Index | Offset from last | Last | Offset from middle | Middle

Details

Specify the input column that is the last column of the submatrix to be overwritten. You can set this parameter to one of the following values:

  • Last - the last input column.

  • Index - specify the input column using the Ending column index parameter.

  • Offset from last - input column with index N - colOffset, where N is the number of input columns and colOffset is the value specified in the Ending column offset parameter.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns and colOffset is the value specified in the Ending column offset parameter.

  • Middle is the input column with index floor (N/2 + 1), where N is the number of input columns.

Dependencies

To enable this parameter, set the Column span parameter to Range of columns and the Starting column parameter to any value other than Last.

Values

Index | Offset from last | Last | Offset from middle | Middle
Default value

Last
Program usage name

ColEndMode
Tunable

No
Evaluatable

No

# Ending column index — last column index
Integer

Details

Specify the index of the input column, which is the last column of the submatrix to be overwritten, as a positive integer.

Dependencies

To enable this parameter, set the Ending column parameter to Index.

Default value

1
Program usage name

ColEndIndex
Tunable

No
Evaluatable

Yes

# Ending column offset — last column offset
Integer

Details

Specify the offset of the input column that is the last column of the submatrix to be overwritten. Set Ending column to one of the following values:

  • Offset from last - input column with index N - colOffset, where N is the number of input columns and colOffset is the value specified in this parameter.

  • Offset from middle - input column with index floor (N/2 + 1 - colOffset), where N is the number of input columns and colOffset is the value you specify in this parameter.

Dependencies

To enable this parameter, set the Ending column parameter to Offset from middle or Offset from last.

Default value

1
Program usage name

ColEndOffset
Tunable

No
Evaluatable

Yes