Main Content


Find dimensions with specified label



dim = finddim(X,label) returns the dimensions in X that have the dimension label label. If the data format of X does not contain the dimension label label, dim is empty.


collapse all

Create a formatted dlarray with some repeated dimension labels. Specify the dimension labels as 'TSSU'. The dlarray call reorders the labels, because it enforces the order 'SCBTU'. For more information about dimension labels, see Usage.

dlX = dlarray(randn(5,4,3,2),'TSSU');

Obtain the dimensions with the label 'T'.

dimT = finddim(dlX,'T')
dimT = 3

Obtain the dimensions with the label 'S'.

dimS = finddim(dlX,'S')
dimS = 1×2

     1     2

Obtain the dimensions with the label 'B'.

dimB = finddim(dlX,'B')
dimB =

  1x0 empty double row vector

Obtain the size of the dlX dimensions labeled 'S'.

SSize = size(dlX,finddim(dlX,'S'))
SSize = 1×2

     4     3

Input Arguments

collapse all

Input dlarray, specified as a dlarray object.

Example: X = dlarray(randn(3,4),'ST')

Single dimension label, specified as one of the following dlarray dimension labels:

  • S — Spatial

  • C — Channel

  • B — Batch observations

  • T — Time or sequence

  • U — Unspecified

Example: "C"

Data Types: char | string

Output Arguments

collapse all

Dimension, returned as a real vector. If no label in the input array X matches label, dim is empty. So if X is unformatted, dim is empty.

Extended Capabilities

Version History

Introduced in R2019b

See Also

| |