2.3.3.3.52. NXlockin¶
Status:
base class (contribution), extends NXobject
Description:
A base class definition for a lock-in amplifier. ...
A base class definition for a lock-in amplifier.
The lock-in amplifier information: the device is being used to extract a (potentially) very weak input signal buried in the noisy background, where the input signal has the same frequency (or its harmonic) as carrier signal or reference signal, using heterodyne detection.
This method extracts the amplitude and phase shift between input signal and reference signal.
In single phase lock-in amplifiers used in high signal-to-noise ratio applications, only the amplitude is measured and phase difference is set to zero.
In two phase lock-in amplifiers used in low signal-to-noise ratio applications, both the amplitude and phase difference are measured.
Fields with partial names like low_passN, high_passN, etc., can be repeated for each channel of the lockin amplifier. It is envisioned that these fields are named low_pass_0, low_pass_1, and so on.
Symbols:
No symbol table
- Groups cited:
Structure:
bias_divider: (optional) NX_CHAR
Bias divider for lock-in channel. ...
Bias divider for lock-in channel. math: Bias divider $= frac{V_{mathrm{ref}}}{V_{mathrm{ref}} + V_{mathrm{input}}}$
modulation_status: (optional) NX_BOOLEAN
Switch the lock-in modulation on or off.
modulation_signal: (optional) NX_CHAR
Type of the modulation or reference signal, voltage | current | bias. ...
Type of the modulation or reference signal, voltage | current | bias. The name of the current or voltage signal can be also specified according to their purpose (e.g., bias voltage).
Any of these values or a custom value (if you use a custom value, also set @custom=True):
voltage
|current
|bias
modulation_frequency: (optional) NX_NUMBER {units=NX_FREQUENCY}
The frequency of the sine modulation that is used to modulate the signal in ...
The frequency of the sine modulation that is used to modulate the signal in lock-in.
reference_amplitude: (optional) NX_NUMBER {units=NX_ANY}
Amplitude of the reference signal for the lock-in amplifier. ...
Amplitude of the reference signal for the lock-in amplifier. Unit could be NX_VOLTAGE or NX_CURRENT depending on the type of the reference signal.
reference_frequency: (optional) NX_NUMBER {units=NX_FREQUENCY}
Frequency of the reference signal for the lock-in amplifier.
reference_phase: (optional) NX_NUMBER {units=NX_ANGLE}
Phase of the reference signal set in the lock-in amplifier.
phase_difference: (optional) NX_NUMBER {units=NX_ANGLE}
Phase difference between the input signal and the reference signal. ...
Phase difference between the input signal and the reference signal. This is used in two phase lock-in amplifiers. In single phase lock-in amplifiers, this value is set to zero.
demodulated_signal: (optional) NX_CHAR
Type of the demodulated signal, current | voltage | bias. ...
Type of the demodulated signal, current | voltage | bias. The name of the current or voltage signal can be also specified according to their purpose (e.g., bias voltage).
Any of these values or a custom value (if you use a custom value, also set @custom=True):
current
|voltage
|bias
demodulated_frequency: (optional) NX_NUMBER {units=NX_FREQUENCY}
The frequency of the demodulated signal.
frequency_modulation_bandwidth: (optional) NX_NUMBER {units=NX_FREQUENCY}
The bandwidth of the modulating signal.
phase_modulation_bandwidth: (optional) NX_NUMBER {units=NX_FREQUENCY}
The bandwidth of the modulating signal over which modulated signal spreads.
amplitude_modulation_bandwidth: (optional) NX_NUMBER {units=NX_FREQUENCY}
The bandwidth of the modulating signal over which modulated signal spreads.
demodulated_amplitude: (optional) NX_NUMBER {units=NX_ANY}
The amplitude of the demodulated signal. ...
The amplitude of the demodulated signal. Unit could be NX_VOLTAGE or NX_CURRENT depending on the type of the demodulated signal.
demodulated_phase: (optional) NX_NUMBER {units=NX_ANGLE}
The phase of the demodulated signal.
demodulator_channels: (optional) NX_CHAR
Comma separated list of the demodulator channels.
low_passN: (optional) NX_NUMBER {units=NX_FREQUENCY}
Frequency of the low-pass filter or cut-off frequency. Only signals below ...
Frequency of the low-pass filter or cut-off frequency. Only signals below this frequency are passed through the filter. N is envisioned to represent the channel number e.g., low_pass1.
high_passN: (optional) NX_NUMBER {units=NX_FREQUENCY}
Frequency of the high-pass filter or cut-off frequency. Only signals above ...
Frequency of the high-pass filter or cut-off frequency. Only signals above this frequency are passed through the filter. N is envisioned to represent the channel number e.g., high_pass1.
lp_filter_orderN: (optional) NX_NUMBER
Order of the low-pass filter applied on the input or demodulated signals (X, Y ...
Order of the low-pass filter applied on the input or demodulated signals (X, Y). Reducing the bandwidth or increasing the order reduces noise on the demodulated signals, but increases settling and measurement times. N is envisioned to represent the channel number e.g., lp_filter_order1.
hp_filter_orderN: (optional) NX_NUMBER
Order of the high-pass filter applied on the input or demodulated ...
Order of the high-pass filter applied on the input or demodulated signal. This is used mainly to suppress a DC component of the input signal noise. N is envisioned to represent the channel number e.g., hp_filter_order1.
ref_offset_phaseN: (optional) NX_NUMBER {units=NX_ANGLE}
An extra phase offset added to the reference signal in modulation step. ...
An extra phase offset added to the reference signal in modulation step. N is envisioned to represent the channel number e.g., hp_filter_order1.
harmonic_orderN: (optional) NX_NUMBER
The reference signal can be a higher harmonic of the modulation signal. ...
The reference signal can be a higher harmonic of the modulation signal. Here the order of the harmonic is stored. N is envisioned to represent the channel number e.g., harmonic_order1.
sensitivity_factor: (optional) NX_NUMBER {units=NX_DIMENSIONLESS}
Ratio of output signal amplitude to input signal amplitude (V/V).
dc_offset_valueN: (optional) NX_NUMBER {units=NX_ANY}
The DC offset of the demodulated signal. ...
The DC offset of the demodulated signal. This is used to remove the DC component from the demodulated signal.
The same DC offset might be applied to the input signal in the modulation process. N is envisioned to represent the channel number e.g., dc_offset_value1.
hardware: (optional) NXfabrication
Hardware manufacturers and type (product number) of lock-in amplifier.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.