Skip to content

NI SCOPE Waveform Measurements Attributes

Jump to bottom
ni-siray edited this page May 7, 2021 · 2 revisions

Waveform Measurements Attributes

NISCOPE_ATTRIBUTE_MEAS_OTHER_CHANNEL

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViString R/W Channel None None

Description

Specifies the second channel for two-channel measurements. If processing steps are registered with this channel, the processing is done before the waveform is used in a two-channel measurement.

Default Value: 0

NISCOPE_ATTRIBUTE_MEAS_ARRAY_GAIN

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Every element of an array is multiplied by this scalar value during the Array Gain measurement.

Default Value: 1.0

NISCOPE_ATTRIBUTE_MEAS_ARRAY_OFFSET

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Every element of an array is added to this scalar value during the Array Offset measurement.

Default Value: 0.0

NISCOPE_ATTRIBUTE_MEAS_HYSTERESIS_PERCENT

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Digital hysteresis that is used in several of the scalar waveform measurements. This attribute specifies the percentage of the full-scale vertical range for the hysteresis window size.

Default Value: 2%

NISCOPE_ATTRIBUTE_MEAS_LAST_ACQ_HISTOGRAM_SIZE

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Specifies the number of bins in the last acquisition histogram. This histogram is used to determine several scalar measurements, such as voltage low and voltage high.

Default Value: 256

NISCOPE_ATTRIBUTE_MEAS_VOLTAGE_HISTOGRAM_SIZE

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Determines the multiple acquisition voltage histogram size. The size is set the first time a voltage histogram measurement is called after clearing the measurement history with the function niScope_ClearWaveformMeasurementStats.

Default Value: 256

NISCOPE_ATTRIBUTE_MEAS_VOLTAGE_HISTOGRAM_LOW_VOLTS

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the lowest voltage value included in the multiple-acquisition voltage histogram.

Default Value: –10.0 V

NISCOPE_ATTRIBUTE_MEAS_VOLTAGE_HISTOGRAM_HIGH_VOLTS

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the highest voltage value included in the multiple acquisition voltage histogram.

Default Value: 10.0 V

NISCOPE_ATTRIBUTE_MEAS_TIME_HISTOGRAM_SIZE

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Determines the multiple acquisition voltage histogram size. The size is set during the first call to a time histogram measurement after clearing the measurement history with niScope_ClearWaveformMeasurementStats.

Default Value: 256

NISCOPE_ATTRIBUTE_MEAS_TIME_HISTOGRAM_LOW_VOLTS

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the lowest voltage value included in the multiple acquisition time histogram.

Default Value: –10.0 V

NISCOPE_ATTRIBUTE_MEAS_TIME_HISTOGRAM_HIGH_VOLTS

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the highest voltage value included in the multiple-acquisition time histogram.

Default Value: 10.0 V

NISCOPE_ATTRIBUTE_MEAS_TIME_HISTOGRAM_LOW_TIME

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the lowest time value n seconds included in the multiple-acquisition time histogram.

Default Value: –5.0e-4 seconds

NISCOPE_ATTRIBUTE_MEAS_TIME_HISTOGRAM_HIGH_TIME

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the highest time value included in the multiple acquisition time histogram. The units are always seconds.

Default Value: 5.0e-4 seconds

NISCOPE_ATTRIBUTE_MEAS_POLYNOMIAL_INTERPOLATION_ORDER

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Specifies the polynomial order used for the polynomial interpolation measurement. For example, an order of 1 is linear interpolation whereas an order of 2 specifies parabolic interpolation. Any positive integer is valid.

Default Value: 1

NISCOPE_ATTRIBUTE_MEAS_INTERPOLATION_SAMPLING_FACTOR

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Indirectly specifies the new number of points for polynomial interpolation measurements. The new number of points is the input number of points times the sampling factor.

Default Value: 2.0

NISCOPE_ATTRIBUTE_MEAS_FILTER_TYPE

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Specifies the type of filter, for both IIR and FIR filters.

Default Value: Lowpass

Defined Values

NISCOPE_VAL_MEAS_LOWPASS (0)

NISCOPE_VAL_MEAS_HIGHPASS (1)

NISCOPE_VAL_MEAS_BANDPASS (2)

NISCOPE_VAL_MEAS_BANDSTOP (3)

Related topics:

  • Reference Levels
  • Measuring Reference-Level Crossings


NISCOPE_ATTRIBUTE_MEAS_FILTER_TAPS

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Defines the number of taps (coefficients) for an FIR filter.

Default Value: 25

Related topics:

  • Reference Levels
  • Measuring Reference-Level Crossings


NISCOPE_ATTRIBUTE_MEAS_FIR_FILTER_WINDOW

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Specifies the FIR window type. The symmetric windows are applied to the FIR filter coefficients to limit passband ripple in FIR filters.

Default Value: NISCOPE_VAL_NONE

Defined Values

NISCOPE_VAL_NONE (0)

NISCOPE_VAL_HANNING_WINDOW (409)

NISCOPE_VAL_FLAT_TOP_WINDOW (410)

NISCOPE_VAL_HAMMING_WINDOW (420)

NISCOPE_VAL_TRIANGLE_WINDOW (423)

NISCOPE_VAL_BLACKMAN_WINDOW (424)

Related topics:

  • Reference Levels
  • Measuring Reference-Level Crossings


NISCOPE_ATTRIBUTE_MEAS_FILTER_WIDTH

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the width of bandpass and bandstop type filters in hertz. The cutoff frequencies occur at NISCOPE_ATTRIBUTE_MEAS_FILTER_CENTER_FREQ ±one-half width.

Default Value: 1.0e3 Hz

NISCOPE_ATTRIBUTE_MEAS_FILTER_ORDER

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViInt32 R/W Channel None None

Description

Specifies the order of an IIR filter. All positive integers are valid.

Default Value: 2

Related topics:

  • Reference Levels
  • Measuring Reference-Level Crossings


NISCOPE_ATTRIBUTE_MEAS_FILTER_CUTOFF_FREQ

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the cutoff frequency in hertz for filters of type lowpass and highpass. The cutoff frequency definition varies depending on the filter.

Default Value: 1.0e6 Hz

NISCOPE_ATTRIBUTE_MEAS_FILTER_CENTER_FREQ

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

The center frequency in hertz for bandpass and bandstop filters. The width of the filter is specified by NISCOPE_ATTRIBUTE_MEAS_FILTER_WIDTH, where the cutoff frequencies are the center ±width.

Default Value: 1.0e6 Hz

NISCOPE_ATTRIBUTE_MEAS_FILTER_RIPPLE

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Specifies the amount of passband ripple in decibels (positive values) for Chebyshev filters.

Default Value: 0.1 dB

NISCOPE_ATTRIBUTE_MEAS_FILTER_TRANSIENT_WAVEFORM_PERCENT

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

The percentage (0 - 100%) of the IIR filtered waveform to eliminate from the beginning of the waveform. This allows eliminating the transient portion of the waveform that is undefined due to the assumptions necessary at the boundary condition.

Default Value: 20.0%

NISCOPE_ATTRIBUTE_MEAS_CHAN_LOW_REF_LEVEL

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Stores the low reference level used in many scalar measurements. Different channels may have different reference levels.

Default Value: 10%

NISCOPE_ATTRIBUTE_MEAS_CHAN_MID_REF_LEVEL

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Stores the mid reference level used in many scalar measurements. Different channels may have different reference levels.

Default Value: 50%

NISCOPE_ATTRIBUTE_MEAS_CHAN_HIGH_REF_LEVEL

Specific Attribute

Data
type		 Access Applies to Coercion High Level Functions
ViReal64 R/W Channel None None

Description

Stores the high reference level used in many scalar measurements. Different channels may have different reference levels.

Default Value: 90%

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally