lteNSSSIndices

Generate narrowband secondary synchronization signal resource element indices for subframe

Syntax

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

Description

ind = lteNSSSIndices(enb) returns the resource element (RE) indices for the narrowband secondary synchronization signal (NSSS) ind for the input cell-wide settings specified by enb.

ind = lteNSSSIndices(enb,port) returns the NSSS RE indices for the relevant antenna port specified by port.

example

ind = lteNSSSIndices(enb,port,opts) returns the NSSS RE indices for the specified antenna port in the format specified by opts.

Examples

collapse all

Generate zero-based NSSS RE indices for antenna port 2001.

Initialize cell-wide settings by specifying the operation mode, number of cell-specific RS antenna ports, physical layer cell identity, frame number, and subframe number.

enb.OperationMode = 'Inband-SamePCI';    % Operation mode
enb.CellRefP = 1;                        % Number of cell-specific RS antenna ports
enb.NCellID = 2;                         % Physical layer cell identity
enb.NSubframe = 9;                       % Subframe number
enb.NFrame = 4;                          % Frame number

Specify the antenna port and generate the NSSS RE indices, specifying zero-based indexing. To return a matrix whose rows each contain the subcarrier, index, and antenna port of the corresponding RE, specify the option 'sub'.

port = 1;
ind = lteNSSSIndices(enb,port,{'0based','sub'});

Input Arguments

collapse all

Cell-wide settings, specified as a structure. You can specify enb to contain any of these fields.

NB-IoT operation mode, specified as 'Standalone', 'Inband-SamePCI', 'Inband-DifferentPCI', or 'Guardbandband'.

Data Types: char

Narrowband physical layer cell identity, specified as an integer in the interval [0, 503].

Data Types: double

Subframe number, specified as an integer. Because the NSSS is defined only for subframe 9 in alternate frames, lteNSSSIndices returns an empty array for any value of NSubframe other than 9. This behavior enables resource grid indexing for any subframe number. If NSubframe and is unspecified, then lteNSSSIndices assumes NSubframe takes its default value.

Data Types: double

Frame number, specified as an integer. Because the NSSS is defined only for subframe 9 in alternate frames, lteNSSSIndices returns an empty vector for odd values of NFrame. This behavior enables resource grid indexing for any subframe number and any frame number. If the NSubframe and NFrame fields are unspecified, lteNSSSIndices assumes NFrame takes its default value.

Data Types: double

Physical layer cell identity, specified as an integer in the interval [0, 503]. Specify the NCellID and CellRefP fields to exclude cell reference signal (RS) locations. If you do not specify both the NCellID and CellRefP fields, all cell RS locations are included.

Dependencies

This field applies only when you specify OperationMode as 'Inband-SamePCI' or 'Inband-DifferentPCI'.

Data Types: double

Number of cell-specific antenna ports, specified as 1, 2, or 4. Specify the NCellID and CellRefP fields to exclude cell RS locations. If you do not specify both the NCellID and CellRefP fields, all cell RS locations are included.

Dependencies

This field applies only when you specify OperationMode as 'Inband-SamePCI' or 'Inband-DifferentPCI'.

Data Types: double

Data Types: struct

Antenna port, specified as 0 or 1, corresponding to antenna port 2000 or 2001, respectively.

Data Types: double

Output format and index base of generated indices, specified as a character vector, a cell array of character vectors, or a string array according to this table. You can specify these options as a single character vector or string scalar by a space-separated list of values placed inside quotation marks.

OptionValuesDescription
Output format'ind' (default), 'sub'Output format of generated indices, specified as 'ind' or 'sub'. The function returns the indices as a column vector when you specify 'ind'. The function returns the indices as an NRE-by-3 matrix when you specify 'sub', where NRE is the number of resource elements. Each row of the matrix contains the subcarrier, symbol, and antenna port as its first, second, and third entries, respectively.
Index base'1based' (default), '0based'Index base, specified as '1based' or '0based'. To generate indices whose first value is 1, specify '1based'. To generate indices whose first value is 0, specify '0based'.

Example: 'ind 0based', "ind 0based", {'ind','0based'}, and ["ind","0based"] specify the same output options.

Data Types: char | string | cell

Output Arguments

collapse all

NSSS RE indices for a subframe, returned as a complex-valued array. The array dimensions depend on the format options you specify in opts. To return ind as a column vector, specify 'ind' for the opts input. To return ind as an NRE-by-3 matrix, specify 'sub' for the opts input. If you specify the NSubframe field as any value other than 9 or the NFrame field as an odd value, lteNSSSIndices returns ind as an empty array.

Data Types: uint32

Introduced in R2019a