IqRecorder

SCPI Commands :

INITiate:GPRF:MEASurement<Instance>:IQRecorder
ABORt:GPRF:MEASurement<Instance>:IQRecorder
STOP:GPRF:MEASurement<Instance>:IQRecorder
READ:GPRF:MEASurement<Instance>:IQRecorder
FETCh:GPRF:MEASurement<Instance>:IQRecorder

class IqRecorderCls[source]

IqRecorder commands group definition. 13 total commands, 5 Subgroups, 5 group commands

abort(opc_timeout_ms: int = -1) → None[source]

# SCPI: ABORt:GPRF:MEASurement<Instance>:IQRecorder
driver.gprf.measurement.iqRecorder.abort()


    INTRO_CMD_HELP: Starts, stops or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the RUN state.
    - STOP... halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

param opc_timeout_ms:

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

fetch() → List[float][source]

# SCPI: FETCh:GPRF:MEASurement<Instance>:IQRecorder
value: List[float] = driver.gprf.measurement.iqRecorder.fetch()

Returns the I and Q amplitudes in the format specified by FORMat:BASE:DATA. For a detailed description of the data formats, see ‘ASCII and binary data formats’. For the number of values n, see method RsCMPX_Gprf.Configure.Gprf. Measurement.IqRecorder.Capture.set.

Suppressed linked return values: reliability

return:

iq_samples: For ASCII format: Comma-separated list of I and Q amplitudes {I, Q}1, …, {I, Q}n For REAL format: Binary block data as listed in the table below. There are no commas within this parameter.

initiate(save_to_iq_file: FileSave = None) → None[source]

# SCPI: INITiate:GPRF:MEASurement<Instance>:IQRecorder
driver.gprf.measurement.iqRecorder.initiate(save_to_iq_file = enums.FileSave.OFF)


    INTRO_CMD_HELP: Starts, stops or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the RUN state.
    - STOP... halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

param save_to_iq_file:

Optional parameter, selecting whether the results are written to an I/Q file, to the memory or both. For file selection, see method RsCMPX_Gprf.Configure.Gprf.Measurement.IqRecorder.iqFile. OFF: The results are only stored in the memory. ON: The results are stored in the memory and in a file. ONLY: The results are only stored in a file.

read() → List[float][source]

# SCPI: READ:GPRF:MEASurement<Instance>:IQRecorder
value: List[float] = driver.gprf.measurement.iqRecorder.read()

Returns the I and Q amplitudes in the format specified by FORMat:BASE:DATA. For a detailed description of the data formats, see ‘ASCII and binary data formats’. For the number of values n, see method RsCMPX_Gprf.Configure.Gprf. Measurement.IqRecorder.Capture.set.

Suppressed linked return values: reliability

return:

iq_samples: For ASCII format: Comma-separated list of I and Q amplitudes {I, Q}1, …, {I, Q}n For REAL format: Binary block data as listed in the table below. There are no commas within this parameter.

stop(opc_timeout_ms: int = -1) → None[source]

# SCPI: STOP:GPRF:MEASurement<Instance>:IQRecorder
driver.gprf.measurement.iqRecorder.stop()


    INTRO_CMD_HELP: Starts, stops or aborts the measurement:

    - INITiate... starts or restarts the measurement. The measurement enters the RUN state.
    - STOP... halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
    - ABORt... halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.

Use FETCh…STATe? to query the current measurement state.

param opc_timeout_ms:

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

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.gprf.measurement.iqRecorder.clone()

Subgroups