ChpConfiguration

Provides methods to configure the Chp measurement.

class nirfmxspecan.chp_configuration.ChpConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Chp measurement.

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

Configures averaging for the channel power (CHP) measurement.

Parameters:

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

  • averaging_enabled (enums.ChpAveragingEnabled, 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.ChpAveragingType, int) –

    This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. Refer to the Averaging section of the Spectral Measurements Concepts topic for more information about averaging types. The default value is RMS.

    Name (Value)

    Description

    RMS (0)

    The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power spectrum is averaged in a logarithmic scale.

    Scalar (2)

    The square root of the power spectrum is averaged.

    Max (3)

    The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

    Min (4)

    The least power in the spectrum at each frequency bin 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_carrier_offset(selector_string, carrier_frequency)[source]

Configures the center frequency of the carrier, relative to the RF center frequency.

Use “carrier< * n * >” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of carrier number.

    Example:

    ”carrier0”

    You can use the build_carrier_string() method to build the selector string.

  • carrier_frequency (float) – This parameter specifies the center frequency, in Hz, of the carrier, relative to the RF CENTER_FREQUENCY. The default value is 0.

Returns:

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

Return type:

int

configure_detector(selector_string, detector_type, detector_points)[source]

Configures the detector settings, including detector type and the number of points to be detected.

Parameters:

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

  • detector_type (enums.ChpDetectorType, int) –

    This parameter specifies the type of detector to be used. The default value is None. Refer to Spectral Measurements Concepts topic for more information on detectors.

    Name (Value)

    Description

    None (0)

    The detector is disabled.

    Sample (1)

    The middle sample in the bucket is detected.

    Normal (2)

    The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

    Peak (3)

    The maximum value of the samples in the bucket is detected.

    Negative Peak (4)

    The minimum value of the samples in the bucket is detected.

    Average RMS (5)

    The average RMS of all the samples in the bucket is detected.

    Average Voltage (6)

    The average voltage of all the samples in the bucket is detected.

    Average Log (7)

    The average log of all the samples in the bucket is detected.

  • detector_points (int) – This parameter specifies the number of points after the detector is applied. The default value is 1001.

Returns:

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

Return type:

int

configure_fft(selector_string, fft_window, fft_padding)[source]

Configures window and FFT to obtain a spectrum for the channel power (CHP) measurement.

Parameters:

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

  • fft_window (enums.ChpFftWindow, int) –

    This parameter specifies the FFT window type to use to reduce spectral leakage. Refer to the Window and FFT section of the Spectral Measurements Concepts topic for more information about FFT window types. The default value is Flat Top.

    Name (Value)

    Description

    None (0)

    Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

    Flat Top (1)

    Measures single-tone amplitudes accurately.

    Hanning (2)

    Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

    Hamming (3)

    Analyzes closely-spaced sine waves.

    Gaussian (4)

    Provides a balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

    Blackman (5)

    Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

    Blackman-Harris (6)

    Useful as a general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

    Kaiser-Bessel (7)

    Separates two tones with frequencies close to each other but with widely-differing amplitudes.

  • fft_padding (float) – This parameter specifies the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula: FFT size = waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth. The default value is -1.

Returns:

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

Return type:

int

configure_integration_bandwidth(selector_string, integration_bandwidth)[source]

Configures the frequency range, in Hz, over which the measurement integrates the power. Use “carrier<n>” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of carrier number.

    Example:

    ”carrier0”

    You can use the build_carrier_string() method to build the selector string.

  • integration_bandwidth (float) – This parameter specifies the frequency range, in Hz, over which the measurement integrates the carrier channel power. The default value is 1 MHz.

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_carriers(selector_string, number_of_carriers)[source]

Configures the number of carriers for a channel power (CHP) measurement.

Parameters:

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

  • number_of_carriers (int) – This parameter specifies the number of carriers. The default value is 1.

Returns:

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

Return type:

int

configure_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the resolution bandwidth (RBW) filter.

Parameters:

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

  • rbw_auto (enums.ChpRbwAutoBandwidth, int) –

    This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the CHP topic for more details on RBW and sweep time. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the RBW that you specify in the RBW parameter.

    True (1)

    The measurement computes the RBW.

  • rbw (float) – This parameter specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW Auto parameter to False. This value is expressed in Hz. The default value is 10 kHz.

  • rbw_filter_type (enums.ChpRbwFilterType, int) –

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

    Name (Value)

    Description

    FFT Based (0)

    No RBW filtering is performed.

    Gaussian (1)

    An RBW filter with a Gaussian response is applied.

    Flat (2)

    An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

configure_rrc_filter(selector_string, rrc_filter_enabled, rrc_alpha)[source]

Configures the root raised cosine (RRC) filter to apply on the channel before measuring the channel power. Use “carrier<n>” as the selector string to configure this method.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of carrier number.

    Example:

    ”carrier0”

    You can use the build_carrier_string() method to build the selector string.

  • rrc_filter_enabled (enums.ChpCarrierRrcFilterEnabled, int) –

    This parameter specifies whether to apply the RRC filter on the acquired channel before measuring the channel power. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement measures the channel power directly on the acquired channel.

    True (1)

    The measurement applies the RRC filter on the acquired channel before measuring the channel power.

  • 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_span(selector_string, span)[source]

Configures the frequency range, in Hz, around the center frequency, to acquire for the channel power (CHP) measurement.

Parameters:

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

  • span (float) – This parameter specifies the frequency range, in Hz, around the center frequency, to acquire for the measurement. The default value is 1 MHz.

Returns:

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

Return type:

int

configure_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time.

Parameters:

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

  • sweep_time_auto (enums.ChpSweepTimeAuto, int) –

    This parameter specifies whether the measurement computes the sweep time. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the sweep time that you specify in the Sweep Time Interval parameter.

    True (1)

    The measurement calculates the sweep time based on the value of the CHP RBW attribute.

  • sweep_time_interval (float) – This parameter specifies the sweep time, in seconds, when you set the Sweep Time Auto parameter to False. 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

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the CHP 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.

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 CHP 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_amplitude_correction_type(selector_string)[source]

Gets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAmplitudeCorrectionType):

Specifies whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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_ENABLED 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.

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_ENABLED 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 CHP 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.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CHP measurement uses the CHP Averaging Count attribute as the number of acquisitions over which the CHP measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAveragingEnabled):

Specifies whether to enable averaging for the CHP 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 averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP 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.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP 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_carrier_frequency(selector_string)[source]

Gets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. 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_carrier_integration_bandwidth(selector_string)[source]

Gets the frequency range, over which the measurement integrates the power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency range, over which the measurement integrates the power. 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_carrier_rrc_filter_alpha(selector_string)[source]

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

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the roll-off factor of 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_carrier_rrc_filter_enabled(selector_string)[source]

Gets whether to apply the root-raised-cosine (RRC) filter on the acquired channel before measuring the channel power.

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

The default value is False.

Name (Value)

Description

False (0)

The channel power of the acquired channel is measured directly.

True (1)

The measurement applies the RRC filter on the acquired channel before measuring the channel power.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpCarrierRrcFilterEnabled):

Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired channel before measuring the channel power.

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_detector_points(selector_string)[source]

Gets the number of trace points after the detector is applied.

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 1001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of trace points after the detector is applied.

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_detector_type(selector_string)[source]

Gets the type of detector to be used.

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 None.

Refer to Spectral Measurements Concepts topic for more information on detector types.

Name (Value)

Description

None (0)

The detector is disabled.

Sample (1)

The middle sample in the bucket is detected.

Normal (2)

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

Peak (3)

The maximum value of the samples in the bucket is detected.

Negative Peak (4)

The minimum value of the samples in the bucket is detected.

Average RMS (5)

The average RMS of all the samples in the bucket is detected.

Average Voltage (6)

The average voltage of all the samples in the bucket is detected.

Average Log (7)

The average log of all the samples in the bucket is detected.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpDetectorType):

Specifies the type of detector to be used.

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_fft_padding(selector_string)[source]

Gets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (FFT). The FFT size is given by the following formula:

waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth of the device.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the factor by which the time-domain waveform is zero-padded before fast Fourier transform (FFT). The FFT size is given by the following formula:

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_fft_window(selector_string)[source]

Gets the FFT window type to use to reduce spectral leakage.

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 Flat Top.

Name (Value)

Description

None (0)

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

Flat Top (1)

Measures single-tone amplitudes accurately.

Hanning (2)

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

Hamming (3)

Analyzes closely-spaced sine waves.

Gaussian (4)

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

Blackman (5)

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

Blackman-Harris (6)

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

Kaiser-Bessel (7)

Separates two tones with frequencies close to each other but with widely-differing amplitudes.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpFftWindow):

Specifies the FFT window type to use to reduce spectral leakage.

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 CHP 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the CHP 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_mode(selector_string)[source]

Gets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 Measure.

Name (Value)

Description

Measure (0)

CHP measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

Manual noise calibration of the signal analyzer is performed for the CHP measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpMeasurementMode):

Specifies whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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_calibration_averaging_auto(selector_string)[source]

Gets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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.

Name (Value)

Description

False (0)

RFmx uses the averages that you set for the CHP Noise Cal Averaging Count attribute.

True (1)

RFmx uses a noise calibration averaging count of 32.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCalibrationAveragingAuto):

Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.

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_calibration_averaging_count(selector_string)[source]

Gets the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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 32.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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_calibration_mode(selector_string)[source]

Gets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 Auto.

Name (Value)

Description

Manual (0)

When you set the CHP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the CHP measurement manually. When you set the CHP Meas Mode attribute to Measure, you can initiate the CHP measurement manually.

Auto (1)

When you set the CHP Noise Comp Enabled attribute to True, RFmx sets Input Isolation Enabled to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for noise of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the CHP Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the CHP measurement without compensating for the noise contribution of the instrument.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCalibrationMode):

Specifies whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 noise compensation.

True (1)

Enables noise compensation.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCompensationEnabled):

Specifies whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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_type(selector_string)[source]

Gets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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 Analyzer and Termination.

Name (Value)

Description

Analyzer and Termination (0)

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

Analyzer Only (1)

Compensates for the analyzer noise only.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpNoiseCompensationType):

Specifies the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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 CHP 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for CHP 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_carriers(selector_string)[source]

Gets the number of carriers.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of carriers.

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_rbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the measurement computes the resolution bandwidth (RBW).

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.

Name (Value)

Description

False (0)

The measurement uses the RBW that you specify in the CHP RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpRbwAutoBandwidth):

Specifies whether the measurement computes the resolution bandwidth (RBW).

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_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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 10 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_rbw_filter_bandwidth_definition(selector_string)[source]

Gets the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH attribute.

The default value is 3dB.

Name (Value)

Description

3dB (0)

Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the CHP RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the CHP FFT Window attribute.

Bin Width (2)

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the CHP RBW Filter Type attribute to FFT Based.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpRbwFilterBandwidthDefinition):

Specifies the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH attribute.

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_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.

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpRbwFilterType):

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_span(selector_string)[source]

Gets the frequency range around the center frequency, to acquire for the measurement. 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 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency range around the center frequency, to acquire for the measurement. 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_sweep_time_auto(selector_string)[source]

Gets whether the measurement computes the sweep time.

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.

Name (Value)

Description

False (0)

The measurement uses the sweep time that you specify in the CHP Sweep Time attribute.

True (1)

The measurement calculates the sweep time based on the value of the CHP RBW attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChpSweepTimeAuto):

Specifies whether the measurement computes the sweep time.

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_sweep_time_interval(selector_string)[source]

Gets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the CHP 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the CHP measurement.

Returns:

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

Return type:

int

set_amplitude_correction_type(selector_string, value)[source]

Sets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:
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_ENABLED 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED 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 CHP 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.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CHP measurement uses the CHP Averaging Count attribute as the number of acquisitions over which the CHP measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpAveragingEnabled, int) – Specifies whether to enable averaging for the CHP 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 averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP 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.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for CHP measurement.

Returns:

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

Return type:

int

set_carrier_frequency(selector_string, value)[source]

Sets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. 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_carrier_integration_bandwidth(selector_string, value)[source]

Sets the frequency range, over which the measurement integrates the power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency range, over which the measurement integrates the power. 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_carrier_rrc_filter_alpha(selector_string, value)[source]

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

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

The default value is 0.1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the roll-off factor of 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_carrier_rrc_filter_enabled(selector_string, value)[source]

Sets whether to apply the root-raised-cosine (RRC) filter on the acquired channel before measuring the channel power.

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

The default value is False.

Name (Value)

Description

False (0)

The channel power of the acquired channel is measured directly.

True (1)

The measurement applies the RRC filter on the acquired channel before measuring the channel power.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpCarrierRrcFilterEnabled, int) – Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired channel before measuring the channel power.

Returns:

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

Return type:

int

set_detector_points(selector_string, value)[source]

Sets the number of trace points after the detector is applied.

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 1001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of trace points after the detector is applied.

Returns:

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

Return type:

int

set_detector_type(selector_string, value)[source]

Sets the type of detector to be used.

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 None.

Refer to Spectral Measurements Concepts topic for more information on detector types.

Name (Value)

Description

None (0)

The detector is disabled.

Sample (1)

The middle sample in the bucket is detected.

Normal (2)

The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.

Peak (3)

The maximum value of the samples in the bucket is detected.

Negative Peak (4)

The minimum value of the samples in the bucket is detected.

Average RMS (5)

The average RMS of all the samples in the bucket is detected.

Average Voltage (6)

The average voltage of all the samples in the bucket is detected.

Average Log (7)

The average log of all the samples in the bucket is detected.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpDetectorType, int) – Specifies the type of detector to be used.

Returns:

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

Return type:

int

set_fft_padding(selector_string, value)[source]

Sets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (FFT). The FFT size is given by the following formula:

waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth of the device.

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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the factor by which the time-domain waveform is zero-padded before fast Fourier transform (FFT). The FFT size is given by the following formula:

Returns:

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

Return type:

int

set_fft_window(selector_string, value)[source]

Sets the FFT window type to use to reduce spectral leakage.

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 Flat Top.

Name (Value)

Description

None (0)

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

Flat Top (1)

Measures single-tone amplitudes accurately.

Hanning (2)

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

Hamming (3)

Analyzes closely-spaced sine waves.

Gaussian (4)

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.

Blackman (5)

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

Blackman-Harris (6)

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

Kaiser-Bessel (7)

Separates two tones with frequencies close to each other but with widely-differing amplitudes.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpFftWindow, int) – Specifies the FFT window type to use to reduce spectral leakage.

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 CHP 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the CHP 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_mode(selector_string, value)[source]

Sets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 Measure.

Name (Value)

Description

Measure (0)

CHP measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

Manual noise calibration of the signal analyzer is performed for the CHP measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpMeasurementMode, int) –

    Specifies whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_calibration_averaging_auto(selector_string, value)[source]

Sets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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.

Name (Value)

Description

False (0)

RFmx uses the averages that you set for the CHP Noise Cal Averaging Count attribute.

True (1)

RFmx uses a noise calibration averaging count of 32.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpNoiseCalibrationAveragingAuto, int) – Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.

Returns:

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

Return type:

int

set_noise_calibration_averaging_count(selector_string, value)[source]

Sets the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

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 32.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_AUTO attribute to False.

Returns:

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

Return type:

int

set_noise_calibration_mode(selector_string, value)[source]

Sets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 Auto.

Name (Value)

Description

Manual (0)

When you set the CHP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the CHP measurement manually. When you set the CHP Meas Mode attribute to Measure, you can initiate the CHP measurement manually.

Auto (1)

When you set the CHP Noise Comp Enabled attribute to True, RFmx sets Input Isolation Enabled to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the CHP measurement, including compensation for noise of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the CHP Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the CHP measurement without compensating for the noise contribution of the instrument.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpNoiseCalibrationMode, int) –

    Specifies whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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 noise compensation.

True (1)

Enables noise compensation.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpNoiseCompensationEnabled, int) –

    Specifies whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the NOISE_CALIBRATION_MODE attribute to Auto, or set the CHP Noise Cal Mode attribute to Manual and MEASUREMENT_MODE attribute to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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_type(selector_string, value)[source]

Sets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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 Analyzer and Termination.

Name (Value)

Description

Analyzer and Termination (0)

Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.

Analyzer Only (1)

Compensates for the analyzer noise only.
Parameters:
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 CHP 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for CHP 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_carriers(selector_string, value)[source]

Sets the number of carriers.

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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of carriers.

Returns:

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

Return type:

int

set_rbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the measurement computes the resolution bandwidth (RBW).

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.

Name (Value)

Description

False (0)

The measurement uses the RBW that you specify in the CHP RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpRbwAutoBandwidth, int) – Specifies whether the measurement computes the resolution bandwidth (RBW).

Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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 10 kHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_rbw_filter_bandwidth_definition(selector_string, value)[source]

Sets the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH attribute.

The default value is 3dB.

Name (Value)

Description

3dB (0)

Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the CHP RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the CHP FFT Window attribute.

Bin Width (2)

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the CHP RBW Filter Type attribute to FFT Based.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH attribute.

Returns:

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

Return type:

int

set_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.

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpRbwFilterType, 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_span(selector_string, value)[source]

Sets the frequency range around the center frequency, to acquire for the measurement. 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 1 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency range around the center frequency, to acquire for the measurement. 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_sweep_time_auto(selector_string, value)[source]

Sets whether the measurement computes the sweep time.

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.

Name (Value)

Description

False (0)

The measurement uses the sweep time that you specify in the CHP Sweep Time attribute.

True (1)

The measurement calculates the sweep time based on the value of the CHP RBW attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ChpSweepTimeAuto, int) – Specifies whether the measurement computes the sweep time.

Returns:

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

Return type:

int

set_sweep_time_interval(selector_string, value)[source]

Sets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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

validate_noise_calibration_data(selector_string)[source]

Indicates whether calibration data is valid for the configuration specified by the signal name in the Selector string parameter.

Parameters:

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

Returns:

noise_calibration_data_valid (enums.ChpNoiseCalibrationDataValid):

This parameter returns whether the calibration data is valid.

Name (Value)

Description

False (0)

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

True (1)

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.
error_code (int):

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

Return type:

Tuple (noise_calibration_data_valid, error_code)