HarmConfiguration

Provides methods to configure the Harm measurement.

class nirfmxspecan.harm_configuration.HarmConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Harm measurement.

configure_auto_harmonics(selector_string, auto_harmonics_setup_enabled)[source]

Configures auto configuration of successive harmonics. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

auto_harmonics_setup_enabled (enums.HarmAutoHarmonicsSetupEnabled, int) –

This parameter specifies whether to enable auto configuration of successive harmonics. The default value is True.

Name (Value)	Description
False (0)	The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.
True (1)	The measurement uses the Harm Num Harmonics attribute and configuration of the fundamental to configure successive harmonics. Bandwidth of Nth order harmonic = N * (Bandwidth of fundamental). Measurement interval of Nth order harmonics = (Measurement interval of fundamental)/N

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the harmonics measurement. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

averaging_enabled (enums.HarmAveragingEnabled, int) –

This parameter specifies whether to enable averaging for the measurement. The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The measurement uses the value of the Averaging Count parameter to calculate the number of acquisitions over which the measurement is averaged.

averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

averaging_type (enums.HarmAveragingType, int) –

This parameter specifies the averaging type for averaging the power over multiple acquisitions. The averaged power trace is used for the measurement. Refer to the Averaging section of the Spectrum topic for more information about averaging types. The default value is RMS.

Name (Value)	Description
RMS (0)	The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
Log (1)	The power trace is averaged in a logarithmic scale.
Scalar (2)	The square root of the power trace is averaged.
Max (3)	The peak power in the power trace at each sample instance is retained from one acquisition to the next.
Min (4)	The least power in the power trace at each sample instance is retained from one acquisition to the next.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_fundamental_measurement_interval(selector_string, measurement_interval)[source]

Configures the acquisition time, in seconds, for acquiring the fundamental signal. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_interval (float) – This parameter specifies the acquisition time, in seconds, for the Harmonics measurement of the fundamental signal. The default value is 1 ms.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_fundamental_rbw(selector_string, rbw, rbw_filter_type, rrc_alpha)[source]

Configures the resolution bandwidth (RBW) filter to be applied on the acquired signal. The bandwidth of the filter specified is applicable for fundamental signal. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter used to acquire the fundamental signal. The default value is 100 kHz.

rbw_filter_type (enums.HarmRbwFilterType, int) –

This parameter specifies the shape of the digital RBW filter. The default value is Gaussian.

Name (Value)	Description
None (1)	The measurement does not use any RBW filtering.
Gaussian (2)	An RBW filter with a Gaussian response is applied.
Flat (3)	An RBW filter with a flat response is applied.
RRC (4)	The measurement uses RRC FIR coefficients for filtering.

rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_harmonic(selector_string, harmonic_order, harmonic_bandwidth, harmonic_enabled, harmonic_measurement_interval)[source]

Configures the harmonic frequency, acquisition bandwidth, and acquisition time for the harmonic, when you set the AUTO_SETUP_ENABLED attribute to False. Use “harmonic<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of harmonic number.

Example:

”harmonic0”

You can use the build_harmonic_string() method to build the selector string.
harmonic_order (int) –
This parameter specifies the order of the harmonic. The default value is 1.

Frequency of Nth order harmonic = N * (Frequency of fundamental)
harmonic_bandwidth (float) – This parameter specifies the resolution bandwidth, in Hz, for the harmonic. The default value is 100 kHz.
harmonic_enabled (enums.HarmHarmonicEnabled, int) –
This parameter specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). The default value is True.

Name (Value)

Description

False (0)

Disables the harmonic for measurement.

True (1)

Enables the harmonic for measurement.
harmonic_measurement_interval (float) – This parameter specifies the acquisition time, in seconds, for the harmonic. The default value is 1 ms.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_harmonic_array(selector_string, harmonic_order, harmonic_bandwidth, harmonic_enabled, harmonic_measurement_interval)[source]

Configures the harmonic frequency, acquisition bandwidth, and acquisition time for the harmonic, when you set the AUTO_SETUP_ENABLED attribute to False. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
harmonic_order (int) –
This parameter specifies the array of the orders of the harmonics. The default value is 1.

Frequency of Nth order harmonic = N * (Frequency of fundamental)
harmonic_bandwidth (float) – This parameter specifies the array of resolution bandwidths, in Hz, for the harmonic. The default value is 100 kHz.
harmonic_enabled (enums.HarmHarmonicEnabled, int) –
This parameter specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). The default value is True.

Name (Value)

Description

False (0)

Disables the harmonic for measurement.

True (1)

Enables the harmonic for measurement.
harmonic_measurement_interval (float) – This parameter specifies the array of acquisition times, in seconds, for the harmonic. The default value is 1 ms.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_number_of_harmonics(selector_string, number_of_harmonics)[source]

Configures the number of harmonics, including fundamental, to measure. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_harmonics (int) – This parameter specifies the number of harmonics, including fundamental, to measure. The default value is 3.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the traces to be stored and retrieved after performing the Harmonics measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_setup_enabled(selector_string)[source]

Gets whether to enable auto configuration of successive harmonics.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.
True (1)	The measurement uses the Harm Num Harmonics attribute and configuration of the fundamental to configure successive harmonics. Bandwidth of Nth order harmonic = N * (Bandwidth of fundamental). Measurement interval of Nth order harmonics = (Measurement interval of fundamental)/N

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmAutoHarmonicsSetupEnabled):: Specifies whether to enable auto configuration of successive harmonics.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_COUNT attribute to True.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of acquisitions used for averaging when you set the AVERAGING_COUNT attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The Harmonics measurement uses the Harm Averaging Count attribute as the number of acquisitions over which the Harmonics measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmAveragingEnabled):: Specifies whether to enable averaging for the Harmonics measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_type(selector_string)[source]

Gets the averaging type for the Harmonics measurement. The averaged power trace is used for the measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is RMS.

Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668

Name (Value)	Description
RMS (0)	The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
Log (1)	The power trace is averaged in a logarithmic scale.
Scalar (2)	The square root of the power trace is averaged.
Max (3)	The maximum instantaneous power in the power trace is retained from one acquisition to the next.
Min (4)	The minimum instantaneous power in the power trace is retained from one acquisition to the next.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmAveragingType):: Specifies the averaging type for the Harmonics measurement. The averaged power trace is used for the measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fundamental_measurement_interval(selector_string)[source]

Gets the acquisition time for the Harmonics measurement of the fundamental signal. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.001.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the acquisition time for the Harmonics measurement of the fundamental signal. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fundamental_rbw_filter_alpha(selector_string)[source]

Gets the roll-off factor for the root-raised-cosine (RRC) filter.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the roll-off factor for the root-raised-cosine (RRC) filter.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fundamental_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter used to measure the fundamental signal. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 100 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the fundamental signal. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fundamental_rbw_filter_type(selector_string)[source]

Gets the shape of the digital resolution bandwidth (RBW) filter.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Gaussian.

Supported devices: PXIe-5665/5668

Name (Value)	Description
None (5)	The measurement does not use any RBW filtering.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.
RRC (6)	The RRC filter with the roll-off specified by the Harm Fundamental RBW RRC Alpha attribute is used as the RBW filter.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmRbwFilterType):: Specifies the shape of the digital resolution bandwidth (RBW) filter.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_harmonic_bandwidth(selector_string)[source]

Gets the resolution bandwidth for the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True. This value is expressed in Hz.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 100 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the resolution bandwidth for the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_harmonic_enabled(selector_string)[source]

Gets whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	Disables the harmonic for measurement.
True (1)	Enables the harmonic for measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmHarmonicEnabled):: Specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). This attribute is not used if you set the AUTO_SETUP_ENABLED to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_harmonic_measurement_interval(selector_string)[source]

Gets the acquisition time for the harmonic. This value is expressed in seconds. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 1 ms.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the acquisition time for the harmonic. This value is expressed in seconds. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_harmonic_order(selector_string)[source]

Gets the order of the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Frequency of Nth order harmonic = N * (Frequency of fundamental)

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the order of the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the Harmonics measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_method(selector_string)[source]

Gets the method used to perform the harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Time Domain.

Name (Value)	Description
Time Domain (0)	The harmonics measurement acquires the signal using the same signal analyzer setting across frequency bands. Use this method when the measurement speed is desirable over higher dynamic range.
Dynamic Range (2)	The harmonics measurement acquires the signal using the hardware-specific features, such as the IF filter and IF gain, for different frequency bands. Use this method to get the best dynamic range.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmMeasurementMethod):: Specifies the method used to perform the harmonics measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_noise_compensation_enabled(selector_string)[source]

Gets whether to enable compensation of the average harmonic powers for inherent noise floor of the signal analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	Disables compensation of the average harmonic powers for the noise floor of the signal analyzer.
True (1)	Enables compensation of the average harmonic powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the harmonics measurement and cached for future use. If the signal analyzer or measurement parameters change, noise floors are measured again.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HarmNoiseCompensationEnabled):: Specifies whether to enable compensation of the average harmonic powers for inherent noise floor of the signal analyzer.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for Harmonics measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the maximum number of threads used for parallelism for Harmonics measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_harmonics(selector_string)[source]

Gets the number of harmonics, including fundamental, to measure.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 3.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of harmonics, including fundamental, to measure.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the Harmonics measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_auto_setup_enabled(selector_string, value)[source]

Sets whether to enable auto configuration of successive harmonics.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses manual configuration for the harmonic order, harmonic bandwidth, and harmonic measurement interval.
True (1)	The measurement uses the Harm Num Harmonics attribute and configuration of the fundamental to configure successive harmonics. Bandwidth of Nth order harmonic = N * (Bandwidth of fundamental). Measurement interval of Nth order harmonics = (Measurement interval of fundamental)/N

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmAutoHarmonicsSetupEnabled, int) – Specifies whether to enable auto configuration of successive harmonics.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_COUNT attribute to True.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_COUNT attribute to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The Harmonics measurement uses the Harm Averaging Count attribute as the number of acquisitions over which the Harmonics measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmAveragingEnabled, int) – Specifies whether to enable averaging for the Harmonics measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for the Harmonics measurement. The averaged power trace is used for the measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is RMS.

Supported devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5668

Name (Value)	Description
RMS (0)	The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
Log (1)	The power trace is averaged in a logarithmic scale.
Scalar (2)	The square root of the power trace is averaged.
Max (3)	The maximum instantaneous power in the power trace is retained from one acquisition to the next.
Min (4)	The minimum instantaneous power in the power trace is retained from one acquisition to the next.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmAveragingType, int) – Specifies the averaging type for the Harmonics measurement. The averaged power trace is used for the measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fundamental_measurement_interval(selector_string, value)[source]

Sets the acquisition time for the Harmonics measurement of the fundamental signal. This value is expressed in seconds.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.001.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the acquisition time for the Harmonics measurement of the fundamental signal. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fundamental_rbw_filter_alpha(selector_string, value)[source]

Sets the roll-off factor for the root-raised-cosine (RRC) filter.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fundamental_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter used to measure the fundamental signal. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 100 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the fundamental signal. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fundamental_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital resolution bandwidth (RBW) filter.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Gaussian.

Supported devices: PXIe-5665/5668

Name (Value)	Description
None (5)	The measurement does not use any RBW filtering.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.
RRC (6)	The RRC filter with the roll-off specified by the Harm Fundamental RBW RRC Alpha attribute is used as the RBW filter.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (RBW) filter.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_harmonic_bandwidth(selector_string, value)[source]

Sets the resolution bandwidth for the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True. This value is expressed in Hz.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 100 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the resolution bandwidth for the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_harmonic_enabled(selector_string, value)[source]

Sets whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	Disables the harmonic for measurement.
True (1)	Enables the harmonic for measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmHarmonicEnabled, int) – Specifies whether to enable a particular harmonic for measurement. Only the enabled harmonics are used to measure the total harmonic distortion (THD). This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_harmonic_measurement_interval(selector_string, value)[source]

Sets the acquisition time for the harmonic. This value is expressed in seconds. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 1 ms.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the acquisition time for the harmonic. This value is expressed in seconds. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_harmonic_order(selector_string, value)[source]

Sets the order of the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Frequency of Nth order harmonic = N * (Frequency of fundamental)

Use “harmonic<n>” as the Selector String to configure or read this attribute.

The default value is 1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the order of the harmonic. This attribute is not used if you set the AUTO_SETUP_ENABLED to True.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the Harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the Harmonics measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_measurement_method(selector_string, value)[source]

Sets the method used to perform the harmonics measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Time Domain.

Name (Value)	Description
Time Domain (0)	The harmonics measurement acquires the signal using the same signal analyzer setting across frequency bands. Use this method when the measurement speed is desirable over higher dynamic range.
Dynamic Range (2)	The harmonics measurement acquires the signal using the hardware-specific features, such as the IF filter and IF gain, for different frequency bands. Use this method to get the best dynamic range.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmMeasurementMethod, int) – Specifies the method used to perform the harmonics measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_noise_compensation_enabled(selector_string, value)[source]

Sets whether to enable compensation of the average harmonic powers for inherent noise floor of the signal analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	Disables compensation of the average harmonic powers for the noise floor of the signal analyzer.
True (1)	Enables compensation of the average harmonic powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the harmonics measurement and cached for future use. If the signal analyzer or measurement parameters change, noise floors are measured again.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HarmNoiseCompensationEnabled, int) – Specifies whether to enable compensation of the average harmonic powers for inherent noise floor of the signal analyzer.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for Harmonics measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the maximum number of threads used for parallelism for Harmonics measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_harmonics(selector_string, value)[source]

Sets the number of harmonics, including fundamental, to measure.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 3.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of harmonics, including fundamental, to measure.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int