histogram ¶

The histogram commands module.

These commands are used in the following models: MDO3

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries

- HIStogram:BOX <NR3>, <NR3>, <NR3>, <NR3>
- HIStogram:BOX?
- HIStogram:BOXPcnt <NR2>, <NR2>, <NR2>, <NR2>
- HIStogram:BOXPcnt?
- HIStogram:COUNt RESET
- HIStogram:DATa?
- HIStogram:DISplay {OFF|LOG|LINEAr}
- HIStogram:DISplay?
- HIStogram:END?
- HIStogram:MODe {HORizontal|VERTical|OFF}
- HIStogram:MODe?
- HIStogram:SOUrce {CH<x>|MATH|REF<x>}
- HIStogram:SOUrce?
- HIStogram:STARt?
- HIStogram?

Histogram ¶

Bases: SCPICmdRead

The HIStogram command.

Description

This query-only query returns all histogram parameters; it queries the state of all histogram parameters that the user can set. This command is equivalent to selecting Waveform Histograms from the Measure menu.

Usage

Using the .query() method will send the HIStogram? query.
Using the .verify(value) method will send the HIStogram? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram?

Properties

.box: The HIStogram:BOX command.
.boxpcnt: The HIStogram:BOXPcnt command.
.count: The HIStogram:COUNt command.
.data: The HIStogram:DATa command.
.display: The HIStogram:DISplay command.
.end: The HIStogram:END command.
.mode: The HIStogram:MODe command.
.source: The HIStogram:SOUrce command.
.start: The HIStogram:STARt command.

box `property` ¶

box: HistogramBox

Return the HIStogram:BOX command.

Description

This command specifies the histogram box coordinates in terms of source waveform vertical and horizontal units.

Usage

Using the .query() method will send the HIStogram:BOX? query.
Using the .verify(value) method will send the HIStogram:BOX? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:BOX value command.

SCPI Syntax

- HIStogram:BOX <NR3>, <NR3>, <NR3>, <NR3>
- HIStogram:BOX?

Info

<NR3> is a floating point number that specifies the left position of the histogram box in source waveform horizontal units.
<NR3> specifies the top position of the histogram box in source waveform vertical units.
<NR3> specifies the right position of the histogram box in source waveform horizontal units.
<NR3> specifies the bottom position of the histogram box in source waveform vertical units.

boxpcnt `property` ¶

boxpcnt: HistogramBoxpcnt

Return the HIStogram:BOXPcnt command.

Description

This command specifies the histogram box coordinates in terms of percentages of the full screen extents of the source waveform. The arguments refer to the left (percent of the horizontal screen extent), top (percent of the vertical screen extent), right (percent of the horizontal screen extent), bottom (percent of the vertical screen extent). The valid range for these values is 0.0 to 100.0.

Usage

Using the .query() method will send the HIStogram:BOXPcnt? query.
Using the .verify(value) method will send the HIStogram:BOXPcnt? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:BOXPcnt value command.

SCPI Syntax

- HIStogram:BOXPcnt <NR2>, <NR2>, <NR2>, <NR2>
- HIStogram:BOXPcnt?

Info

<NR3> is a floating point number that specifies the left position of the histogram box in percentage coordinates. The default value is 20%.
<NR3> specifies the top position of the histogram box in percentage coordinates. The default value is 80%.
<NR3> specifies the right position of the histogram box in percentage coordinates. The default value is 80%.
<NR3> specifies the bottom position of the histogram box in percentage coordinates. The default value is 20%.

count `property` ¶

count: HistogramCount

Return the HIStogram:COUNt command.

Description

This command (no query form) clears the count and statistics for the histogram and the histogram source data. If the histogram is on, then counting restarts.

Usage

Using the .write(value) method will send the HIStogram:COUNt value command.

SCPI Syntax

- HIStogram:COUNt RESET

Info

RESET

data `property` ¶

data: HistogramData

Return the HIStogram:DATa command.

Description

This query returns the histogram data when HIStogram:MODe is HORizontal or VERTical. If the mode is OFF, then no data is returned and an error event is set. The data values returned for this query represent the number of times the histogram source waveform samples were coincident with a particular histogram bin. For vertical histograms, this query returns 256 values, representing the number of times the histogram source waveform samples were coincident with each of the 256 digitizing levels. Of these 256 values, the first 2 and last 3 are always 0, as they represent digitizing levels that fall above and beneath the waveform graticule, respectively. For horizontal histograms, this query returns 1000 values, representing the number of times the histogram source waveform samples were coincident with each horizontal pixel column. The time of occurrence for each of the horizontal bins can be derived using the HISTOGRAM:START and HISTOGRAM:END queries.

Usage

Using the .query() method will send the HIStogram:DATa? query.
Using the .verify(value) method will send the HIStogram:DATa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:DATa?

display `property` ¶

display: HistogramDisplay

Return the HIStogram:DISplay command.

Description

This command sets the scaling of the histogram data display to be the count of each histogram bin or the log of that count. The default scaling is linear.

Usage

Using the .query() method will send the HIStogram:DISplay? query.
Using the .verify(value) method will send the HIStogram:DISplay? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:DISplay value command.

SCPI Syntax

- HIStogram:DISplay {OFF|LOG|LINEAr}
- HIStogram:DISplay?

Info

<LOG> sets the histogram display to logarithmic scaling.
<LINEAr> sets the histogram display to linear scaling. This is the default setting.

end `property` ¶

end: HistogramEnd

Return the HIStogram:END command.

Description

Returns the time (horizontal) or vertical units value (vertical) of the last bin where the histogram data ends. The HISTOGRAM:MODE must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the HISTOGRAM:MODE is HORizontal, the value returned is the time of the right bin. If the HISTOGRAM:MODE is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an .

Usage

Using the .query() method will send the HIStogram:END? query.
Using the .verify(value) method will send the HIStogram:END? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:END?

mode `property` ¶

mode: HistogramMode

Return the HIStogram:MODe command.

Description

This command selects the type of histogram to create or disables the histogram display. The query form either returns the current histogram type or that the histogram display is disabled.

Usage

Using the .query() method will send the HIStogram:MODe? query.
Using the .verify(value) method will send the HIStogram:MODe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:MODe value command.

SCPI Syntax

- HIStogram:MODe {HORizontal|VERTical|OFF}
- HIStogram:MODe?

Info

HORizontal enables a horizontally positioned histogram that shows time distribution.
VERTical enables a vertically positioned histogram that shows a voltage distribution, or another distribution such as amperes.
OFF disables the collection of the histogram measurement.

source `property` ¶

source: HistogramSource

Return the HIStogram:SOUrce command.

Description

This command sets or queries which source will be compared against the histogram box when the histogram testing is enabled.

Usage

Using the .query() method will send the HIStogram:SOUrce? query.
Using the .verify(value) method will send the HIStogram:SOUrce? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:SOUrce value command.

SCPI Syntax

- HIStogram:SOUrce {CH<x>|MATH|REF<x>}
- HIStogram:SOUrce?

Info

CH<x> selects the analog channel waveform to use as the source for the histogram. The x variable can be expressed as an integer ranging from 1 through 4.
MATH selects the math waveform as the source for the histogram.
REF<x> selects a reference waveform as the source for the histogram. The x variable can be expressed as an integer ranging from 1 through 4.

start `property` ¶

start: HistogramStart

Return the HIStogram:STARt command.

Description

Returns the time (horizontal) or vertical units value (vertical) of the first bin where the histogram data starts. The HISTOGRAM:MODE must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the HISTOGRAM:MODE is HORizontal, the value returned is the time of the left bin. If the HISTOGRAM:MODE is VERTical the value returned is the vertical units value of the top bin. The returned value is an .

Usage

Using the .query() method will send the HIStogram:STARt? query.
Using the .verify(value) method will send the HIStogram:STARt? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:STARt?

HistogramBox ¶

Bases: SCPICmdWrite, SCPICmdRead

The HIStogram:BOX command.

Description

This command specifies the histogram box coordinates in terms of source waveform vertical and horizontal units.

Usage

Using the .query() method will send the HIStogram:BOX? query.
Using the .verify(value) method will send the HIStogram:BOX? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:BOX value command.

SCPI Syntax

- HIStogram:BOX <NR3>, <NR3>, <NR3>, <NR3>
- HIStogram:BOX?

Info

<NR3> is a floating point number that specifies the left position of the histogram box in source waveform horizontal units.
<NR3> specifies the top position of the histogram box in source waveform vertical units.
<NR3> specifies the right position of the histogram box in source waveform horizontal units.
<NR3> specifies the bottom position of the histogram box in source waveform vertical units.

HistogramBoxpcnt ¶

Bases: SCPICmdWrite, SCPICmdRead

The HIStogram:BOXPcnt command.

Description

This command specifies the histogram box coordinates in terms of percentages of the full screen extents of the source waveform. The arguments refer to the left (percent of the horizontal screen extent), top (percent of the vertical screen extent), right (percent of the horizontal screen extent), bottom (percent of the vertical screen extent). The valid range for these values is 0.0 to 100.0.

Usage

Using the .query() method will send the HIStogram:BOXPcnt? query.
Using the .verify(value) method will send the HIStogram:BOXPcnt? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:BOXPcnt value command.

SCPI Syntax

- HIStogram:BOXPcnt <NR2>, <NR2>, <NR2>, <NR2>
- HIStogram:BOXPcnt?

Info

<NR3> is a floating point number that specifies the left position of the histogram box in percentage coordinates. The default value is 20%.
<NR3> specifies the top position of the histogram box in percentage coordinates. The default value is 80%.
<NR3> specifies the right position of the histogram box in percentage coordinates. The default value is 80%.
<NR3> specifies the bottom position of the histogram box in percentage coordinates. The default value is 20%.

HistogramCount ¶

Bases: SCPICmdWrite

The HIStogram:COUNt command.

Description

This command (no query form) clears the count and statistics for the histogram and the histogram source data. If the histogram is on, then counting restarts.

Usage

Using the .write(value) method will send the HIStogram:COUNt value command.

SCPI Syntax

- HIStogram:COUNt RESET

Info

RESET

HistogramData ¶

Bases: SCPICmdRead

The HIStogram:DATa command.

Description

This query returns the histogram data when HIStogram:MODe is HORizontal or VERTical. If the mode is OFF, then no data is returned and an error event is set. The data values returned for this query represent the number of times the histogram source waveform samples were coincident with a particular histogram bin. For vertical histograms, this query returns 256 values, representing the number of times the histogram source waveform samples were coincident with each of the 256 digitizing levels. Of these 256 values, the first 2 and last 3 are always 0, as they represent digitizing levels that fall above and beneath the waveform graticule, respectively. For horizontal histograms, this query returns 1000 values, representing the number of times the histogram source waveform samples were coincident with each horizontal pixel column. The time of occurrence for each of the horizontal bins can be derived using the HISTOGRAM:START and HISTOGRAM:END queries.

Usage

Using the .query() method will send the HIStogram:DATa? query.
Using the .verify(value) method will send the HIStogram:DATa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:DATa?

HistogramDisplay ¶

Bases: SCPICmdWrite, SCPICmdRead

The HIStogram:DISplay command.

Description

This command sets the scaling of the histogram data display to be the count of each histogram bin or the log of that count. The default scaling is linear.

Usage

Using the .query() method will send the HIStogram:DISplay? query.
Using the .verify(value) method will send the HIStogram:DISplay? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:DISplay value command.

SCPI Syntax

- HIStogram:DISplay {OFF|LOG|LINEAr}
- HIStogram:DISplay?

Info

<LOG> sets the histogram display to logarithmic scaling.
<LINEAr> sets the histogram display to linear scaling. This is the default setting.

HistogramEnd ¶

Bases: SCPICmdRead

The HIStogram:END command.

Description

Returns the time (horizontal) or vertical units value (vertical) of the last bin where the histogram data ends. The HISTOGRAM:MODE must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the HISTOGRAM:MODE is HORizontal, the value returned is the time of the right bin. If the HISTOGRAM:MODE is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an .

Usage

Using the .query() method will send the HIStogram:END? query.
Using the .verify(value) method will send the HIStogram:END? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:END?

HistogramMode ¶

Bases: SCPICmdWrite, SCPICmdRead

The HIStogram:MODe command.

Description

This command selects the type of histogram to create or disables the histogram display. The query form either returns the current histogram type or that the histogram display is disabled.

Usage

Using the .query() method will send the HIStogram:MODe? query.
Using the .verify(value) method will send the HIStogram:MODe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:MODe value command.

SCPI Syntax

- HIStogram:MODe {HORizontal|VERTical|OFF}
- HIStogram:MODe?

Info

HORizontal enables a horizontally positioned histogram that shows time distribution.
VERTical enables a vertically positioned histogram that shows a voltage distribution, or another distribution such as amperes.
OFF disables the collection of the histogram measurement.

HistogramSource ¶

Bases: SCPICmdWrite, SCPICmdRead

The HIStogram:SOUrce command.

Description

This command sets or queries which source will be compared against the histogram box when the histogram testing is enabled.

Usage

Using the .query() method will send the HIStogram:SOUrce? query.
Using the .verify(value) method will send the HIStogram:SOUrce? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the HIStogram:SOUrce value command.

SCPI Syntax

- HIStogram:SOUrce {CH<x>|MATH|REF<x>}
- HIStogram:SOUrce?

Info

CH<x> selects the analog channel waveform to use as the source for the histogram. The x variable can be expressed as an integer ranging from 1 through 4.
MATH selects the math waveform as the source for the histogram.
REF<x> selects a reference waveform as the source for the histogram. The x variable can be expressed as an integer ranging from 1 through 4.

HistogramStart ¶

Bases: SCPICmdRead

The HIStogram:STARt command.

Description

Returns the time (horizontal) or vertical units value (vertical) of the first bin where the histogram data starts. The HISTOGRAM:MODE must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the HISTOGRAM:MODE is HORizontal, the value returned is the time of the left bin. If the HISTOGRAM:MODE is VERTical the value returned is the vertical units value of the top bin. The returned value is an .

Usage

Using the .query() method will send the HIStogram:STARt? query.
Using the .verify(value) method will send the HIStogram:STARt? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- HIStogram:STARt?

histogram ¶

Histogram ¶

box property ¶

boxpcnt property ¶

count property ¶

data property ¶

display property ¶

end property ¶

mode property ¶

source property ¶

start property ¶

HistogramBox ¶

HistogramBoxpcnt ¶

HistogramCount ¶

HistogramData ¶

HistogramDisplay ¶

HistogramEnd ¶

HistogramMode ¶

HistogramSource ¶

HistogramStart ¶

box `property` ¶

boxpcnt `property` ¶

count `property` ¶

data `property` ¶

display `property` ¶

end `property` ¶

mode `property` ¶

source `property` ¶

start `property` ¶