ltePSSIndices

PSS resource element indices

Description

ind = ltePSSIndices(enb) returns a column vector, ind, of resource element (RE) indices, Port 0 oriented, for the Primary Synchronization Signal (PSS) for the given cell-wide settings structure. By default, the indices are returned in one-based linear indexing form that can directly index elements of a 3-D array representing the resource array. These indices are ordered as the PSS modulation symbols should be mapped. Alternative indexing formats can also be generated.

Note

These indices are only defined for subframes 0 and 5 in FDD, and subframes 1 and 6 in TDD. Therefore, an empty vector is returned for other values of NSubframe. This behavior allows this function and the corresponding sequence function ltePSS to index the resource grid for any subframe number as described in Resource Grid Indexing. However, the resource grid is only modified in subframes 0 and 5 in FDD, or subframes 1 and 6 in TDD.

example

ind = ltePSSIndices(enb,port) returns indices appropriate for antenna port, port.

example

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

Examples

collapse all

Get PSS resource element indices in linear form for antenna port 0.

Create a cell-wide configuration structure initialed for RMC R.4. Generate PSS indices for RMC R.4 for antenna port 0.

enb = lteRMCDL('R.4');
ind = ltePSSIndices(enb,0);
ind(1:4)
ans = 4x1 uint32 column vector

   438
   439
   440
   441

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

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

   437
   438
   439
   440

Input Arguments

collapse all

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

Number of downlink resource blocks, specified as integer from 6 to 110.

Example: 9

Data Types: double

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

Data Types: char | string

Subframe number, specified as nonnegative scalar integer.

Example: 9

Data Types: double

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

Data Types: char | string

Antenna port number, specified as a non-negative scalar 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

PSS resource element indices, returned as an integer column vector or a three-column integer matrix. This output is generated using the cell-wide settings structure, enb.

Data Types: uint32

Introduced in R2014a