Histogram

SCPI Commands :

EXPort:HISTogram:SAVE
EXPort:HISTogram:SELect
EXPort:HISTogram:INCidence
EXPort:HISTogram:DATA
EXPort:HISTogram:NAME

Commands in total: 5

Subgroups: 0

Direct child commands: 5

get_data() → float

# EXPort:HISTogram:DATA
value: float = driver.export.histogram.get_data()

Transfers the histogram data to the controlling computer. The data can be used in MATLAB, for example. To set the export data format, use method RsRtx.formatPy.data.set() .

Returns:

data: List of values according to the format settings and method RsRtx.export.histogram.incidence().

get_incidence() → PositionMode

# EXPort:HISTogram:INCidence
value: enums.PositionMode = driver.export.histogram.get_incidence()

Sets the mode of exported data: relative or absolute frequency of amplitude values.

Returns:

incidence: ABS | REL

get_name() → str

# EXPort:HISTogram:NAME
value: str = driver.export.histogram.get_name()

Sets the file name and path to save the histogram to.

Returns:

path: String with path and file name. The file extension defines the file format: XML, CSV, or BIN.

get_select() → str

# EXPort:HISTogram:SELect
value: str = driver.export.histogram.get_select()

Selects the histogram to be exported.

save(opc_timeout_ms: int = -1) → None

# EXPort:HISTogram:SAVE
driver.export.histogram.save()

Saves the histogram to the file specified with method RsRtx.export.histogram.name() .

Parameters:

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

set_incidence(incidence: PositionMode) → None

# EXPort:HISTogram:INCidence
driver.export.histogram.set_incidence(incidence = enums.PositionMode.ABS)

Sets the mode of exported data: relative or absolute frequency of amplitude values.

Parameters:

incidence – ABS | REL

set_name(path: str) → None

# EXPort:HISTogram:NAME
driver.export.histogram.set_name(path = 'abc')

Sets the file name and path to save the histogram to.

Parameters:

path – String with path and file name. The file extension defines the file format: XML, CSV, or BIN.

set_select(name: str) → None

# EXPort:HISTogram:SELect
driver.export.histogram.set_select(name = 'abc')

Selects the histogram to be exported.