sgram

List of supported commands:

class nardascripting.base.scpi.sgram.ScpiSgram(com: nardascripting.base.comm.CommBase)

SignalShark SGRam SCPI subsystem class.

get_data_frame_count()

Queries the number of valid spectrogram frames

Returns

Number of valid frames

Return type

int

get_data_update(scan_number=-1, timeout=3.0)

Synchronization command, that waits for new measurement results.

Parameters
  • scan_number (Integer number) – ScanNumber of last queried measurement data. The command forces an update, if not set.

  • timeout (Float number) – Timeout value for update data in seconds

Returns

ScanNumber of current measurement data or -1 if error.

Return type

Integer number

note:: Update is only available in RUN and HOLD state!

get_data_update_stop(scan_number=-1, timeout=3.0)

Synchronization command, that waits for new measurement results and stops measurement if new results are available.

Parameters
  • scan_number (Integer number) – ScanNumber of last queried measurement data. The command forces an update, if not set.

  • timeout (Float number) – Timeout value for update data in seconds

Returns

ScanNumber of current measurement data or -1 if error.

Return type

Integer number

note:: Update is only available in RUN and HOLD state!

get_detector(number: int)

Queries the spectrogram detector configuration

Parameters

number (int) – Detektor Number 1…3

Returns

Detector1 (Off, PPk), Detector2 (Off, RMS), Detector3 mode (Off, MPk, Smp, Avg)

Return type

SgramDetectorModes

get_detector_visible()

Queries the spectrogram detector configuration

Returns

Detector (PPk, RMS, MPk, Smp, Avg)

Return type

SgramDetectorModes

get_frame_count()

Queries the maximum number of spectrogram frames

Returns

Max number of Spectrogram Frames

Return type

int

get_scan_number()

Queries the spectrogram scan number

Returns

Scan number

Return type

int

set_detector(number: int, value: nardascripting.base.scpi.enums.SgramDetectorModes)

Sets the spectrogram detector configuration

Parameters
  • number (int) – Detektor Number 1…3

  • value (SgramDetectorModes) – Detector1 (Off,PPk), Detector2 (Off,RMS), Detector3 (Off, MPk, Smp, Avg)

set_detector_visible(value: nardascripting.base.scpi.enums.SgramDetectorModes)

Sets the spectrogram detector configuration

Parameters

value (SgramDetectorModes) – Detector (PPk, RMS, MPk, Smp, Avg)

set_frame_count(value: int)

Sets the maximum number of spectrogram frames

Parameters

value (int) – Max number of Spectrogram Frames