Arb

SCPI Commands :

SOURce:GPRF:GENerator<Instance>:ARB:FOFFset
SOURce:GPRF:GENerator<Instance>:ARB:SCOunt
SOURce:GPRF:GENerator<Instance>:ARB:ASAMples
SOURce:GPRF:GENerator<Instance>:ARB:REPetition
SOURce:GPRF:GENerator<Instance>:ARB:CYCLes
SOURce:GPRF:GENerator<Instance>:ARB:POFFset
SOURce:GPRF:GENerator<Instance>:ARB:CRATe
SOURce:GPRF:GENerator<Instance>:ARB:LOFFset
SOURce:GPRF:GENerator<Instance>:ARB:CRCProtect
SOURce:GPRF:GENerator<Instance>:ARB:STATus

class ArbCls[source]

Arb commands group definition. 28 total commands, 6 Subgroups, 10 group commands

class ScountStruct[source]

Structure for reading output parameters. Fields:

Sample_Count_Time: float: No parameter help available
Sample_Count: List[int]: No parameter help available

get_asamples() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:ASAMples
value: int = driver.source.arb.get_asamples()

Extends the processing time of a waveform file by the specified number of samples. The additional samples are valid in single-shot repetition mode only, see method RsCmwGprfGen.Source.Arb.repetition.

return:

add_samples: numeric Range: 0 to max. (depending on waveform file)

get_crate() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:CRATe
value: float = driver.source.arb.get_crate()

Queries the clock rate of the loaded waveform file. Note: If a multi-segment waveform file is loaded, this command returns the clock rate of the last segment. Use method RsCmwGprfGen.Source.Arb.Msegment.crate to query the clock rates of the individual segments.

return:

clock_rate: float Unit: Hz

get_crc_protect() → YesNoStatus[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:CRCProtect
value: enums.YesNoStatus = driver.source.arb.get_crc_protect()

Indicates whether the loaded ARB file contains a CRC checksum. To get a valid result, the related ARB file must be loaded into the memory. That means, the baseband mode must be ARB and the generator state must be ON. Otherwise, NAV is returned.

return:

crc_protection: NO | YES

get_cycles() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:CYCLes
value: int = driver.source.arb.get_cycles()

Defines how often the ARB file is processed. The ARB cycles are relevant in single-shot repetition mode only, see method RsCmwGprfGen.Source.Arb.repetition.

return:

cycles: numeric Range: 1 to 10000

get_foffset() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:FOFFset
value: float = driver.source.arb.get_foffset()

Sets the frequency offset to be imposed at the baseband during ARB generation.

return:

frequency_offset: numeric Unit: Hz

get_loffset() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:LOFFset
value: float = driver.source.arb.get_loffset()

Queries the level offset (peak to average ratio, PAR) of the loaded waveform file. The PAR is equal to the absolute value of the difference between the ‘RMS Offset’ and the ‘Peak Offset’ (crest factor) . Note: If a multi-segment waveform file is loaded, this command returns the PAR of the last segment. Use method RsCmwGprfGen.Source.Arb.Msegment.par to query the PAR values of the individual segments.

return:

level_offset: float Unit: dB

get_poffset() → float[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:POFFset
value: float = driver.source.arb.get_poffset()

Queries the peak offset of the loaded waveform file. Note: If a multi-segment waveform file is loaded, this command returns the peak offset of the last segment. Use method RsCmwGprfGen.Source.Arb.Msegment.poffset to query the peak offset values of the individual segments.

return:

peak_offset: float Unit: dB

get_repetition() → RepeatMode[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:REPetition
value: enums.RepeatMode = driver.source.arb.get_repetition()

Defines how often the ARB file is processed.

return:

repetition: CONTinuous | SINGle CONTinuous: unlimited, cyclic processing SINGle: The file is processed n times, where n is the number of cycles, see method RsCmwGprfGen.Source.Arb.cycles.

get_scount() → ScountStruct[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:SCOunt
value: ScountStruct = driver.source.arb.get_scount()

Queries the progress of ARB file processing. You can use the command to check in single-shot mode whether ARB file processing is complete. As long as the ARB file is processed, the command returns 0,0,0. In continuous mode, the command always returns 0,0,0. If ARB file processing is complete, the command returns results for the previous ARB file processing.

return:

structure: for return value, see the help for ScountStruct structure arguments.

get_status() → int[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:STATus
value: int = driver.source.arb.get_status()

Queries the number of the currently processed segment. Even for the repetition ‘Continuous Seamless’, the currently processed segment is returned, independent of whether a trigger event for the next segment has already been received or not.

return:

arb_segment_no: decimal NAV is returned if no file is loaded.

set_asamples(add_samples: int) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:ASAMples
driver.source.arb.set_asamples(add_samples = 1)

Extends the processing time of a waveform file by the specified number of samples. The additional samples are valid in single-shot repetition mode only, see method RsCmwGprfGen.Source.Arb.repetition.

param add_samples:

numeric Range: 0 to max. (depending on waveform file)

set_cycles(cycles: int) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:CYCLes
driver.source.arb.set_cycles(cycles = 1)

Defines how often the ARB file is processed. The ARB cycles are relevant in single-shot repetition mode only, see method RsCmwGprfGen.Source.Arb.repetition.

param cycles:

numeric Range: 1 to 10000

set_foffset(frequency_offset: float) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:FOFFset
driver.source.arb.set_foffset(frequency_offset = 1.0)

Sets the frequency offset to be imposed at the baseband during ARB generation.

param frequency_offset:

numeric Unit: Hz

set_repetition(repetition: RepeatMode) → None[source]

# SCPI: SOURce:GPRF:GENerator<Instance>:ARB:REPetition
driver.source.arb.set_repetition(repetition = enums.RepeatMode.CONTinuous)

Defines how often the ARB file is processed.

param repetition:

CONTinuous | SINGle CONTinuous: unlimited, cyclic processing SINGle: The file is processed n times, where n is the number of cycles, see method RsCmwGprfGen.Source.Arb.cycles.

Cloning the Group

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

Subgroups