Documentation |
ts1 = transpose(ts)
ts1 = transpose(ts) returns a new timeseries object, ts1, with IsTimeFirst value set to the opposite of what it is for ts. For example, if ts has the first data dimension aligned with the time vector, ts1 has the last data dimension aligned with the time vector.
The transpose function that is overloaded for timeseries objects does not transpose the data. Instead, this function changes whether the first or the last dimension of the data aligns with the time vector. To transpose the data, transpose the Data property of the time series. For example, you can use the syntax transpose(ts.Data) or (ts.Data).'. The value of the Data property must be a 2-D array.
Consider a time series with 10 samples with the property IsTimeFirst = True. When you transpose this time series, the data size changes from 10-by-1 to 1-by-1-by-10. Note that the first dimension of the Data property is shown explicitly.
The following table summarizes how the size for timeseries data (up to three dimensions) display before and after transposing.
Data Size Before and After Transposing
Size of Original Data | Size of Transposed Data |
---|---|
N-by-1 | 1-by-1-by-N |
N-by-M | M-by-1-by-N |
N-by-M-by-L | M-by-L-by-N |
ts1 |
The timeseries object that is the result of transposing the original timeseries object. |
Suppose that a timeseries object, ts, has ts.Data size 10-by-3-by-2 and its time vector has a length of 10. The IsTimeFirst property of ts is true, which means that the first dimension of the data aligns with the time vector. transpose(ts) modifies the timeseries object, such that the last dimension of the data now aligns with the time vector. This permutes the data, such that the size of ts.Data becomes 3-by-2-by-10.