Ofdm

SCPI Commands :

[SOURce<HW>]:BB:OFDM:ACPLength
[SOURce<HW>]:BB:OFDM:ACPSymbols
[SOURce<HW>]:BB:OFDM:BWOCcupied
[SOURce<HW>]:BB:OFDM:CPSYmbols
[SOURce<HW>]:BB:OFDM:DCMode
[SOURce<HW>]:BB:OFDM:LGUard
[SOURce<HW>]:BB:OFDM:MODulation
[SOURce<HW>]:BB:OFDM:NALLoc
[SOURce<HW>]:BB:OFDM:NOCCupied
[SOURce<HW>]:BB:OFDM:NSUBcarriers
[SOURce<HW>]:BB:OFDM:OFFSet
[SOURce<HW>]:BB:OFDM:OUTPath
[SOURce<HW>]:BB:OFDM:PRESet
[SOURce<HW>]:BB:OFDM:RGUard
[SOURce<HW>]:BB:OFDM:RSAMples
[SOURce<HW>]:BB:OFDM:SAMPling
[SOURce<HW>]:BB:OFDM:SCSPace
[SOURce<HW>]:BB:OFDM:SEQLength
[SOURce<HW>]:BB:OFDM:STATe
[SOURce<HW>]:BB:OFDM:SUBCarriers
[SOURce<HW>]:BB:OFDM:ZSAMples

class OfdmCls

Ofdm commands group definition. 122 total commands, 16 Subgroups, 21 group commands

get_acp_length() → int

# SCPI: [SOURce<HW>]:BB:OFDM:ACPLength
value: int = driver.source.bb.ofdm.get_acp_length()

For f-OFDM/OFDM, enables additional alternative CP.

return:

cp_length: integer Range: 0 to 8192

get_acp_symbols() → int

# SCPI: [SOURce<HW>]:BB:OFDM:ACPSymbols
value: int = driver.source.bb.ofdm.get_acp_symbols()

For f-OFDM/OFDM, defines number of symbols on that the cyclic prefix/the alternative cyclic prefix is applied.

return:

cp_symbols: integer Range: 0 to 8192

get_bw_occupied() → float

# SCPI: [SOURce<HW>]:BB:OFDM:BWOCcupied
value: float = driver.source.bb.ofdm.get_bw_occupied()

Queries the occupied bandwidth.

return:

occ_bw: float Range: 0.001 to 1000, Unit: MHz

get_cp_symbols() → int

# SCPI: [SOURce<HW>]:BB:OFDM:CPSYmbols
value: int = driver.source.bb.ofdm.get_cp_symbols()

For f-OFDM/OFDM, defines number of symbols on that the cyclic prefix/the alternative cyclic prefix is applied.

return:

cp_symbols: integer Range: 0 to 8192

get_dc_mode() → C5GdcMode

# SCPI: [SOURce<HW>]:BB:OFDM:DCMode
value: enums.C5GdcMode = driver.source.bb.ofdm.get_dc_mode()

Sets the DC subcarrier mode.

return:

dc_mode: UTIL| PUNC| SKIP UTIL Uses the DC subcarrier for all allocations. PUNC Replaces the DC subcarrier by zeroes for all allocations. SKIP Skips the DC subcarrier in the discrete Fourier transformation (DFT) .

get_lguard() → int

# SCPI: [SOURce<HW>]:BB:OFDM:LGUard
value: int = driver.source.bb.ofdm.get_lguard()

Queries the number of left guard subcarriers.

return:

left_guard_sc: integer Range: 0 to 1000

get_modulation() → C5Gmod

# SCPI: [SOURce<HW>]:BB:OFDM:MODulation
value: enums.C5Gmod = driver.source.bb.ofdm.get_modulation()

Selects the modulation type.

return:

mod_type: UFMC| FBMC| GFDM| FOFDm| OFDM UFMC Universal Filtered Multi-Carrier modulation, see ‘UFMC’. FBMC Filter Bank Multi-Carrier modulation, see ‘FBMC’. GFDM Generalized Frequency Division Multiplexing, see ‘GFDM’. FOFDm Filtered-OFDM modulation, see ‘f-OFDM’. OFDM Orthogonal Frequency-Division Multiplexing modulation, see ‘OFDM’.

get_nalloc() → int

# SCPI: [SOURce<HW>]:BB:OFDM:NALLoc
value: int = driver.source.bb.ofdm.get_nalloc()

Sets the number of scheduled allocations.

return:

no_of_alloc: integer Range: 0 to 500

get_noccupied() → int

# SCPI: [SOURce<HW>]:BB:OFDM:NOCCupied
value: int = driver.source.bb.ofdm.get_noccupied()

Sets the number of occupied subcarriers.

return:

num_occ_sc: integer Range: 1 to 13107

get_nsubcarriers() → int

# SCPI: [SOURce<HW>]:BB:OFDM:NSUBcarriers
value: int = driver.source.bb.ofdm.get_nsubcarriers()

Sets the number of available subcarriers.

return:

no_of_sub_carr: integer Range: 64 to 16384

get_offset() → int

# SCPI: [SOURce<HW>]:BB:OFDM:OFFSet
value: int = driver.source.bb.ofdm.get_offset()

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the symbol offset that is the number of skipped symbols before inserting the zero padding samples. The maximum offset equals the sequence length minus one symbol, see [:SOURce<hw>]:BB:OFDM:SEQLength.

return:

offset: integer Range: 0 to 2399

get_out_path() → str

# SCPI: [SOURce<HW>]:BB:OFDM:OUTPath
value: str = driver.source.bb.ofdm.get_out_path()

Specifies the output path and output file of the exported OFDM signal generation settings. By default, the output path is /var/user/K114-Export and the output file is Exported_K114_settings_K96.xml. See also Example ‘Default ‘Exported_K114_settings_K96.xml’ file’.

return:

k_114_output_path: string

get_rguard() → int

# SCPI: [SOURce<HW>]:BB:OFDM:RGUard
value: int = driver.source.bb.ofdm.get_rguard()

Queries the number of right guard subcarriers.

return:

right_guard_sc: integer Range: 0 to 1000

get_rsamples() → int

# SCPI: [SOURce<HW>]:BB:OFDM:RSAMples
value: int = driver.source.bb.ofdm.get_rsamples()

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the repetition of inserted zero samples. This repetition defines the number of symbols between repeating zero samples. The maximum number of repetitions equals the sequence length, see [:SOURce<hw>]:BB:OFDM:SEQLength.

return:

rep_for_samples: integer Range: 1 to 2400

get_sampling() → float

# SCPI: [SOURce<HW>]:BB:OFDM:SAMPling
value: float = driver.source.bb.ofdm.get_sampling()

Queries the sampling rate.

return:

samp_rate: float Range: 0.001 to 1000, Unit: MHz

get_sc_space() → float

# SCPI: [SOURce<HW>]:BB:OFDM:SCSPace
value: float = driver.source.bb.ofdm.get_sc_space()

Sets the frequency distance between the carrier frequencies of the subcarriers.

return:

sub_car_sp: float Range: 0.001 to 2, Unit: MHz

get_seq_length() → int

# SCPI: [SOURce<HW>]:BB:OFDM:SEQLength
value: int = driver.source.bb.ofdm.get_seq_length()

Sets the sequence length of the signal in number of symbols.

return:

seq_len: integer Range: 1 to 1000

get_state() → bool

# SCPI: [SOURce<HW>]:BB:OFDM:STATe
value: bool = driver.source.bb.ofdm.get_state()

Activates the standard.

return:

state: 1| ON| 0| OFF

get_subcarriers() → int

# SCPI: [SOURce<HW>]:BB:OFDM:SUBCarriers
value: int = driver.source.bb.ofdm.get_subcarriers()

Queries the number of subcarriers per subband.

return:

subc_per_subband: integer Range: 1 to 16384

get_zsamples() → int

# SCPI: [SOURce<HW>]:BB:OFDM:ZSAMples
value: int = driver.source.bb.ofdm.get_zsamples()

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the number of samples for zero padding. The instrument inserts these zero samples before the modulation symbols. See also ‘Padding with zero samples’. The maximum number equals the total number of subcarriers minus one sample, see [:SOURce<hw>]:BB:OFDM:NSUBcarriers.

return:

zero_samples: integer Range: 0 to 16384

preset() → None

# SCPI: [SOURce<HW>]:BB:OFDM:PRESet
driver.source.bb.ofdm.preset()

Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:OFDM:STATe.

preset_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: [SOURce<HW>]:BB:OFDM:PRESet
driver.source.bb.ofdm.preset_with_opc()

Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:OFDM:STATe.

Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

set_acp_length(cp_length: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:ACPLength
driver.source.bb.ofdm.set_acp_length(cp_length = 1)

For f-OFDM/OFDM, enables additional alternative CP.

param cp_length:

integer Range: 0 to 8192

set_acp_symbols(cp_symbols: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:ACPSymbols
driver.source.bb.ofdm.set_acp_symbols(cp_symbols = 1)

For f-OFDM/OFDM, defines number of symbols on that the cyclic prefix/the alternative cyclic prefix is applied.

param cp_symbols:

integer Range: 0 to 8192

set_cp_symbols(cp_symbols: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:CPSYmbols
driver.source.bb.ofdm.set_cp_symbols(cp_symbols = 1)

For f-OFDM/OFDM, defines number of symbols on that the cyclic prefix/the alternative cyclic prefix is applied.

param cp_symbols:

integer Range: 0 to 8192

set_dc_mode(dc_mode: C5GdcMode) → None

# SCPI: [SOURce<HW>]:BB:OFDM:DCMode
driver.source.bb.ofdm.set_dc_mode(dc_mode = enums.C5GdcMode.PUNC)

Sets the DC subcarrier mode.

param dc_mode:

UTIL| PUNC| SKIP UTIL Uses the DC subcarrier for all allocations. PUNC Replaces the DC subcarrier by zeroes for all allocations. SKIP Skips the DC subcarrier in the discrete Fourier transformation (DFT) .

set_modulation(mod_type: C5Gmod) → None

# SCPI: [SOURce<HW>]:BB:OFDM:MODulation
driver.source.bb.ofdm.set_modulation(mod_type = enums.C5Gmod.FBMC)

Selects the modulation type.

param mod_type:

UFMC| FBMC| GFDM| FOFDm| OFDM UFMC Universal Filtered Multi-Carrier modulation, see ‘UFMC’. FBMC Filter Bank Multi-Carrier modulation, see ‘FBMC’. GFDM Generalized Frequency Division Multiplexing, see ‘GFDM’. FOFDm Filtered-OFDM modulation, see ‘f-OFDM’. OFDM Orthogonal Frequency-Division Multiplexing modulation, see ‘OFDM’.

set_nalloc(no_of_alloc: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:NALLoc
driver.source.bb.ofdm.set_nalloc(no_of_alloc = 1)

Sets the number of scheduled allocations.

param no_of_alloc:

integer Range: 0 to 500

set_noccupied(num_occ_sc: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:NOCCupied
driver.source.bb.ofdm.set_noccupied(num_occ_sc = 1)

Sets the number of occupied subcarriers.

param num_occ_sc:

integer Range: 1 to 13107

set_nsubcarriers(no_of_sub_carr: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:NSUBcarriers
driver.source.bb.ofdm.set_nsubcarriers(no_of_sub_carr = 1)

Sets the number of available subcarriers.

param no_of_sub_carr:

integer Range: 64 to 16384

set_offset(offset: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:OFFSet
driver.source.bb.ofdm.set_offset(offset = 1)

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the symbol offset that is the number of skipped symbols before inserting the zero padding samples. The maximum offset equals the sequence length minus one symbol, see [:SOURce<hw>]:BB:OFDM:SEQLength.

param offset:

integer Range: 0 to 2399

set_out_path(k_114_output_path: str) → None

# SCPI: [SOURce<HW>]:BB:OFDM:OUTPath
driver.source.bb.ofdm.set_out_path(k_114_output_path = 'abc')

Specifies the output path and output file of the exported OFDM signal generation settings. By default, the output path is /var/user/K114-Export and the output file is Exported_K114_settings_K96.xml. See also Example ‘Default ‘Exported_K114_settings_K96.xml’ file’.

param k_114_output_path:

string

set_rsamples(rep_for_samples: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:RSAMples
driver.source.bb.ofdm.set_rsamples(rep_for_samples = 1)

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the repetition of inserted zero samples. This repetition defines the number of symbols between repeating zero samples. The maximum number of repetitions equals the sequence length, see [:SOURce<hw>]:BB:OFDM:SEQLength.

param rep_for_samples:

integer Range: 1 to 2400

set_sc_space(sub_car_sp: float) → None

# SCPI: [SOURce<HW>]:BB:OFDM:SCSPace
driver.source.bb.ofdm.set_sc_space(sub_car_sp = 1.0)

Sets the frequency distance between the carrier frequencies of the subcarriers.

param sub_car_sp:

float Range: 0.001 to 2, Unit: MHz

set_seq_length(seq_len: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:SEQLength
driver.source.bb.ofdm.set_seq_length(seq_len = 1)

Sets the sequence length of the signal in number of symbols.

param seq_len:

integer Range: 1 to 1000

set_state(state: bool) → None

# SCPI: [SOURce<HW>]:BB:OFDM:STATe
driver.source.bb.ofdm.set_state(state = False)

Activates the standard.

param state:

1| ON| 0| OFF

set_zsamples(zero_samples: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:ZSAMples
driver.source.bb.ofdm.set_zsamples(zero_samples = 1)

Requires OFDM modulation type: SOURce1:BB:OFDM:MODulation OFDM Sets the number of samples for zero padding. The instrument inserts these zero samples before the modulation symbols. See also ‘Padding with zero samples’. The maximum number equals the total number of subcarriers minus one sample, see [:SOURce<hw>]:BB:OFDM:NSUBcarriers.

param zero_samples:

integer Range: 0 to 16384

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.bb.ofdm.clone()

Subgroups

• Alloc<AllocationNull>
  • CiqFile
  • Conflict
  • ConPoint<ConstelationPointNull>
    • Imag
    • Magn
    • Phase
    • Real
  • Content
  • Data
  • ListPy
  • Modulation
  • Moor
  • Pattern
  • PhysBits
  • Pwr
  • Scma
    • Codebook
    • Layer<LayerNull>
      • Pwr
      • State
      • User
    • Nlayers
    • Spread
  • Scno
  • ScOffset
  • Splt
    • Scs
      • Size
      • Step
    • State
    • Sym
      • Size
      • Step
  • State
  • Syno
  • SyOffset
  • Zad
    • CycShift
    • Slen
    • Snumber
• Clock
  • Synchronization
    • Execute
• CpLength<Channel>
• CsLength<CoresetLength>
• Dfts
• FilterPy
• Fofdm
• Gfdm
• ModPreset
• Notch<NotchFilter>
  • Apply
  • Bandwidth
    • Absolute
    • Relative
  • Frequency
    • Offset
  • State
• Setting
• SymbolRate
• Trigger
  • Arm
    • Execute
  • Delay
  • Execute
  • External
    • Synchronize
  • Obaseband
  • Output<Output>
    • Delay
    • Foffset
    • Mode
    • OffTime
    • Ontime
    • Period
    • Roffset
  • Time
    • Date
    • Time
• Ufmc
• User<UserNull>
  • Data
  • ListPy
  • Pattern
  • Pwr
  • State
• Waveform