peaktable

List of supported commands:

class nardascripting.base.scpi.peaktable.ScpiPeaktable(com: nardascripting.base.comm.CommBase)

SignalShark PEAKtable SCPI subsystem class.

get_data_count()

Queries the number of peaktable list elements

Returns

Number of peaktable list elements

Return type

int

get_data_frequency()

Queries peaktable frequency data

Returns

List of peaktable frequencies in Hz

Return type

list of float

get_data_level(trace: nardascripting.base.scpi.enums.SpecTraceTypes)

Queries peaktable level data

Parameters

trace (SpecTraceTypes) – RMS, PPk, MPk, Avg, Smp, MnR, AvR, MxR, MxP, MnP, MxA, MxS

Returns

List of power levels in actual unit

Return type

list of float

get_data_scan_number()

PEAKtable data scan number

Returns

Scan number

Return type

int

get_data_tstamp()

Queries PEAKtable data timestamp

Returns

TimeStamp object

Return type

TimeStamp

get_data_tstamp_raw()

Query PEAKtable data timestamp

Returns

Timestamp Sync Flag; Seconds since 1.1.1970 0:00 Greenwich Mean Time; Nanoseconds fractional part

Return type

bool, int, 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_scan_number()

Queries the peaktable scan number

Returns

Scan number

Return type

int

get_trace()

Queries the active trace

Returns

RMS, PPk, MPk, Avg, Smp, MnR, AvR, MxR, MxP, MnP, MxA, MxS

Return type

SpecTraceTypes

get_tstamp()

Queries the time stamp of the peaktable data as datetime object.

DateTime object has a maximum resolution of microseconds.

Returns

Tuple containing: Sync flag as bool; timestamp as datetime object or None if error.

Return type

tuple with size of 2

get_tstamp_raw()

Queries peaktable data timestamp

Returns

Timestamp Sync Flag; Seconds since 1.1.1970 0:00 Greenwich Mean Time; Nanoseconds fractional part

Return type

bool, int, int

set_trace(name: nardascripting.base.scpi.enums.SpecTraceTypes)

Selects the active trace for the peaktable. Only traces enabled by SPECtrum:TRACe:ENABle are available.

Parameters

name (SpecTraceTypes) – RMS, PPk, MPk, Avg, Smp, MnR, AvR, MxR, MxP, MnP, MxA, MxS