spectrochempy.eye

eye(N, M=None, k=0, dtype=float, **kwargs)[source]

Return a 2-D array with ones on the diagonal and zeros elsewhere.

Parameters:

  • N (int) – Number of rows in the output.

  • M (int, optional) – Number of columns in the output. If None, defaults to N .

  • k (int, optional) – Index of the diagonal: 0 (the default) refers to the main diagonal, a positive value refers to an upper diagonal, and a negative value to a lower diagonal.

  • dtype (data-type, optional) – Data-type of the returned array.

  • **kwargs – Other parameters to be passed to the object constructor (units, coordset, mask …).

Returns:

eye – NDDataset of shape (N,M) An array where all elements are equal to zero, except for the k-th diagonal, whose values are equal to one.

See also

identity

Equivalent function with k=0.

diag

Diagonal 2-D NDDataset from a 1-D array specified by the user.

Examples

>>> scp.eye(2, dtype=int)
NDDataset: [float64] unitless (shape: (y:2, x:2))
>>> scp.eye(3, k=1, units='km').values
<Quantity([[       0        1        0]
 [       0        0        1]
 [       0        0        0]], 'kilometer')>