lteSSSIndices

SSS resource element indices

Syntax

ind = lteSSSIndices(enb)
ind = lteSSSIndices(enb,port)
ind = lteSSSIndices(enb,port,opts)

Description

ind = lteSSSIndices(enb) returns a column vector of resource element indices, port 0 oriented, given the parameter fields of structure, enb. It returns a column vector of resource element (RE) indices for the Secondary Synchronization Signal (SSS). By default, the indices are returned in 1-based linear indexing form that can directly index elements of a 3-D array representing the resource array. These indices are ordered as the SSS modulation symbols should be mapped. Alternative indexing formats can also be generated.

These indices are only defined for subframes 0 and 5; therefore, an empty vector is returned for other values of NSubframe. This allows this function and the corresponding sequence function, lteSSS, to be used to index the resource grid, as described in Resource Grid Indexing, for any subframe number. However, the resource grid is only modified in subframes 0 and 5.

ind = lteSSSIndices(enb,port) returns indices appropriate for an antenna port, port, which must be either 0, 1, 2, or 3.

example

ind = lteSSSIndices(enb,port,opts) formats the returned indices using options specified by opts.

Examples

collapse all

Get 0-based SSS resource element indices in linear form for antenna port 0.

enb = lteRMCDL('R.4');
sssIndices = lteSSSIndices(enb,0,{'0based','ind'});
sssIndices(1:4)
ans = 4x1 uint32 column vector

   365
   366
   367
   368

Generate 0-based SSS resource element indices in subscript form for antenna port 0. In this case, a matrix is generated where each row has three columns representing subcarrier, symbol, and antenna port.

Generate 0-based SSS resource element indices in subscript form for antenna port 0.

enb = lteRMCDL('R.4');
sssIndices = lteSSSIndices(enb,0,{'0based','sub'});
sssIndices(1:4,:)
ans = 4x3 uint32 matrix

   5   5   0
   6   5   0
   7   5   0
   8   5   0

The first column of the output represents subcarrier. The second column represents symbol. The third column represents antenna port.

Input Arguments

collapse all

Cell-wide settings, specified as a structure. It contains the following fields.

Number of downlink resource blocks, specified as a positive integer in the interval [6, 110].

Data Types: double

Cyclic prefix length, specified as'Normal' or 'Extended'.

Data Types: char | string

Subframe number, specified as a nonnegative integer.

Data Types: double

Duplex mode, specified as 'FDD' or 'TDD'.

Data Types: char | string

Data Types: struct

Antenna port number, specified as a nonnegative integer.

Example: 2

Data Types: double

Output format options for resource element indices, specified as a character vector, cell array of character vectors, or string array. For convenience, you can specify several options as a single character vector or string scalar by a space-separated list of values placed inside the quotes. Values for opts when specified as a character vector include (use double quotes for string) :

Category Options Description

Indexing style

'ind' (default)

The returned indices are in linear index style.

'sub'

The returned indices are in [subcarrier,symbol,port] subscript row style.

Index base

'1based' (default)

The returned indices are one-based.

'0based'

The returned indices are zero-based.

Example: 'ind 1based', "ind 1based", {'ind','1based'}, or ["ind","1based"] specify the same formatting options.

Data Types: char | string | cell

Output Arguments

collapse all

SSS resource element (RE) indices, returned as a column vector or 3-column integer matrix. By default, the indices are returned in 1-based linear indexing form that can directly index elements of a 3D array representing the resource array. These indices are ordered as the SSS modulation symbols should be mapped. Alternative indexing formats can be generated using the opts input.

Data Types: uint32

Introduced in R2014a