Histogram

SCPI Commands :

LAYout:HISTogram:ADD
LAYout:HISTogram:REMove
LAYout:HISTogram:RESet
Commands in total: 16
Subgroups: 5
Direct child commands: 3
class AddStruct[source]

Structure for setting input parameters. Fields:

  • Histogram_Name: str: String defining the histogram name which is used to refer to the histogram by other functions.

  • Source: enums.SignalSource: Data source of the histogram, see ‘Waveform parameter’

  • Xstart: int: Defines the start value of the x-value range.

  • Xstop: int: Defines the stop value of the x-value range.

  • Ystart: int: Defines the start value of the y-value range.

  • Ystop: int: Defines the stop value of the y-value range.

  • Relative: bool: Defines whether relative or absolute values are used for the value range definition.

  • Orientation: enums.HistogramLayoutMode: VERTical | HORizontal

reset(histogram: str) → None[source]
# LAYout:HISTogram:RESet
driver.layout.histogram.reset(histogram = 'abc')

Resets the values to begin a new histogram.

set_add(value: AddStruct) → None[source]
# LAYout:HISTogram:ADD
structure = driver.layout.histogram.AddStruct()
structure.Histogram_Name: str = 'abc'
structure.Source: enums.SignalSource = enums.SignalSource.AJ1
structure.Xstart: int = 1
structure.Xstop: int = 1
structure.Ystart: int = 1
structure.Ystop: int = 1
structure.Relative: bool = False
structure.Orientation: enums.HistogramLayoutMode = enums.HistogramLayoutMode.HORizontal
driver.layout.histogram.set_add(value = structure)

Defines and displays a new histogram for the specified source. Note: To define the mode of the histogram (vertical or horizontal) , use the method RsRtx.layout.histogram.mode.set() command. For numerical values, the input of a unit is not supported for this command.

Parameters:

value – see the help for AddStruct structure arguments.

set_remove(name: str) → None[source]
# LAYout:HISTogram:REMove
driver.layout.histogram.set_remove(name = 'abc')

Removes the specified histogram.

Cloning the Group

# Create a copy of the original group, that exists independently
histogram_copy = driver.layout.histogram.clone()

Subgroups